Package org.kuali.rice.kew.api.document.attribute

Class DocumentAttributeString.Builder

java.lang.Object

org.kuali.rice.kew.api.document.attribute.DocumentAttribute.AbstractBuilder<String>

org.kuali.rice.kew.api.document.attribute.DocumentAttributeString.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, DocumentAttributeContract

Enclosing class:

DocumentAttributeString

public static final class DocumentAttributeString.Builder
extends DocumentAttribute.AbstractBuilder<String>

A builder implementation which allows for construction of a DocumentAttributeString.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
DocumentAttributeString	build()	Build the DocumentAttribute for this builder based on it's current state.
static DocumentAttributeString.Builder	create(String name)	Create a builder for the document attribute using the given attribute name.
DocumentAttributeDataType	getDataType()	Returns the data type of this document attribute.

Methods inherited from class org.kuali.rice.kew.api.document.attribute.DocumentAttribute.AbstractBuilder

getName, getValue, setName, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static DocumentAttributeString.Builder create(String name)

Create a builder for the document attribute using the given attribute name.

Parameters:

name - the name of the document attribute which should be built by this builder, should never be a null or blank value

Returns:

a builder instance initialized with the given attribute name

getDataType

public DocumentAttributeDataType getDataType()

Description copied from interface: DocumentAttributeContract

Returns the data type of this document attribute. This will generally inform the type of object returned from the #getValue method. This method should never return a null value.

Returns:

the data type of this document attribute

build

public DocumentAttributeString build()

Description copied from class: DocumentAttribute.AbstractBuilder

Build the DocumentAttribute for this builder based on it's current state.

Specified by:

build in interface ModelBuilder

Specified by:

build in class DocumentAttribute.AbstractBuilder<String>

Returns:

the instantiated instance of DocumentAttribute which was built by this builder