|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.identityconnectors.framework.common.objects.AttributeInfoBuilder
public final class AttributeInfoBuilder
Simplifies the process of building 'AttributeInfo' objects. This class is responsible for providing a default implementation of AttributeInfo
. AttributeInfoBuilder bld = new AttributeInfoBuilder("email"); bld.setRequired(true); AttributeInfo info = bld.build();
Constructor Summary | |
---|---|
AttributeInfoBuilder() Creates an builder with all the defaults set. |
|
AttributeInfoBuilder(java.lang.String name) Creates an builder with all the defaults set. |
|
AttributeInfoBuilder(java.lang.String name, java.lang.Class<?> type) Creates an builder with all the defaults set. |
Method Summary | |
---|---|
AttributeInfo |
build() Builds an AttributeInfo object based on the properties set. |
static AttributeInfo |
build(java.lang.String name) Convenience method to create an AttributeInfo. |
static AttributeInfo |
build(java.lang.String name, java.lang.Class<?> type) Convenience method to create an AttributeInfo. |
static AttributeInfo |
build(java.lang.String name, java.lang.Class<?> type, java.util.Set<AttributeInfo.Flags> flags) Convenience method to create an AttributeInfo. |
AttributeInfoBuilder |
setCreateable(boolean value) Determines if the attribute is writable. |
AttributeInfoBuilder |
setFlags(java.util.Set<AttributeInfo.Flags> flags) Sets all of the flags for this builder. |
AttributeInfoBuilder |
setMultiValued(boolean value) Determines if this attribute supports multivalue. |
AttributeInfoBuilder |
setName(java.lang.String name) Sets the unique name of the AttributeInfo object. |
AttributeInfoBuilder |
setObjectClassName(java.lang.String objectClassName) For attributes that hold an embedded object, sets the name of the object class representing that object. |
AttributeInfoBuilder |
setReadable(boolean value) Determines if the attribute is readable. |
AttributeInfoBuilder |
setRequired(boolean value) Determines if this attribute is required. |
AttributeInfoBuilder |
setReturnedByDefault(boolean value) |
AttributeInfoBuilder |
setType(java.lang.Class<?> value) Please see FrameworkUtil.checkAttributeType(Class) for the definitive list of supported types. |
AttributeInfoBuilder |
setUpdateable(boolean value) Determines if this attribute writable during update. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributeInfoBuilder()
IllegalStateException
is thrown.
Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
public AttributeInfoBuilder(java.lang.String name)
IllegalStateException
is thrown.
Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
public AttributeInfoBuilder(java.lang.String name, java.lang.Class<?> type)
IllegalStateException
is thrown.
Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
Method Detail |
---|
public AttributeInfo build()
AttributeInfo
object based on the properties set.AttributeInfo
based on the properties set.public AttributeInfoBuilder setName(java.lang.String name)
AttributeInfo
object.name
- unique name of the AttributeInfo
object.public AttributeInfoBuilder setType(java.lang.Class<?> value)
FrameworkUtil.checkAttributeType(Class)
for the definitive list of supported types.value
- type for an Attribute
's value.java.lang.IllegalArgumentException
- if the Class is not a supported type.public AttributeInfoBuilder setObjectClassName(java.lang.String objectClassName)
objectClassName
- the name of the object class.public AttributeInfoBuilder setReadable(boolean value)
public AttributeInfoBuilder setCreateable(boolean value)
public AttributeInfoBuilder setRequired(boolean value)
public AttributeInfoBuilder setMultiValued(boolean value)
public AttributeInfoBuilder setUpdateable(boolean value)
public AttributeInfoBuilder setReturnedByDefault(boolean value)
public AttributeInfoBuilder setFlags(java.util.Set<AttributeInfo.Flags> flags)
flags
- The set of attribute info flags. Null means clear all flags.
NOTE: EnumSet.noneOf(AttributeInfo.Flags.class) results in an attribute with the default behavior:
public static AttributeInfo build(java.lang.String name, java.lang.Class<?> type, java.util.Set<AttributeInfo.Flags> flags)
new AttributeInfoBuilder(name,type).setFlags(flags).build()
name
- The name of the attributetype
- The type of the attributeflags
- The flags for the attribute. Null means clear all flagspublic static AttributeInfo build(java.lang.String name, java.lang.Class<?> type)
AttributeInfoBuilder.build(name,type,null)
name
- The name of the attributetype
- The type of the attributepublic static AttributeInfo build(java.lang.String name)
AttributeInfoBuilder.build(name,type)
name
- The name of the attribute
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |