org.identityconnectors.framework.common.objects

Class ConnectorObjectBuilder

java.lang.Object

org.identityconnectors.framework.common.objects.ConnectorObjectBuilder

public final class ConnectorObjectBuilder
extends Object

Builder class to create a ConnectorObject. The developer of a Connector will construct a ConnectorObjectBuilder, and then call the ConnectorObjectBuilder to set a Uid, add attributes, and then finally to build() the actual ConnectorObject.

Constructor Summary

Constructors

Constructor and Description
ConnectorObjectBuilder()

Method Summary

Modifier and Type	Method and Description
ConnectorObjectBuilder	add(ConnectorObject obj) Takes all the attribute from a ConnectorObject and add/overwrite the current attributes.
ConnectorObjectBuilder	addAttribute(Attribute[] attrs) Adds many attributes to the ConnectorObject.
ConnectorObjectBuilder	addAttribute(Attribute attr, Attribute... attrs) Adds one or many attributes to the ConnectorObject.
ConnectorObjectBuilder	addAttribute(AttributeBuilder builder, String name, Collection<?> obj) Adds each object in a collection, using a recycled AttributeBuilder.
ConnectorObjectBuilder	addAttribute(AttributeBuilder builder, String name, Object... objs) Adds values to the attribute, using a recycled AttributeBuilder.
ConnectorObjectBuilder	addAttribute(String name, Collection<?> obj) Adds each object in a collection.
ConnectorObjectBuilder	addAttribute(String name, Object... objs) Adds values to the attribute.
ConnectorObjectBuilder	addAttributes(Collection<Attribute> attrs) Add all the Attributes of a Collection.
ConnectorObject	build() Builds a 'ConnectorObject' based on the attributes and Uid provided.
ConnectorObjectBuilder	clearAttributes() Clears all Attributes, for recycling this ConnectionObjectBuilder.
ConnectorObjectBuilder	removeAttribute(String name) Removes an attribute by name.
ConnectorObjectBuilder	setName(Name name)
ConnectorObjectBuilder	setName(String name)
ConnectorObjectBuilder	setObjectClass(ObjectClass oclass)
ConnectorObjectBuilder	setUid(String uid)
ConnectorObjectBuilder	setUid(Uid uid)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorObjectBuilder

public ConnectorObjectBuilder()

Method Detail

setUid

public ConnectorObjectBuilder setUid(String uid)

setUid

public ConnectorObjectBuilder setUid(Uid uid)

setName

public ConnectorObjectBuilder setName(String name)

setName

public ConnectorObjectBuilder setName(Name name)

setObjectClass

public ConnectorObjectBuilder setObjectClass(ObjectClass oclass)

add

public ConnectorObjectBuilder add(ConnectorObject obj)

Takes all the attribute from a ConnectorObject and add/overwrite the current attributes.

addAttribute

public ConnectorObjectBuilder addAttribute(Attribute[] attrs)

Adds many attributes to the ConnectorObject. This method is needed to preserve backward API compatibility.

addAttribute

public ConnectorObjectBuilder addAttribute(Attribute attr,
                                           Attribute... attrs)

Adds one or many attributes to the ConnectorObject.

addAttributes

public ConnectorObjectBuilder addAttributes(Collection<Attribute> attrs)

Add all the Attributes of a Collection.

addAttribute

public ConnectorObjectBuilder addAttribute(String name,
                                           Object... objs)

Adds values to the attribute.

addAttribute

public ConnectorObjectBuilder addAttribute(AttributeBuilder builder,
                                           String name,
                                           Object... objs)

Adds values to the attribute, using a recycled AttributeBuilder.

addAttribute

public ConnectorObjectBuilder addAttribute(String name,
                                           Collection<?> obj)

Adds each object in a collection.

addAttribute

public ConnectorObjectBuilder addAttribute(AttributeBuilder builder,
                                           String name,
                                           Collection<?> obj)

Adds each object in a collection, using a recycled AttributeBuilder.

removeAttribute

public ConnectorObjectBuilder removeAttribute(String name)

Removes an attribute by name.

clearAttributes

public ConnectorObjectBuilder clearAttributes()

Clears all Attributes, for recycling this ConnectionObjectBuilder.

build

public ConnectorObject build()

Builds a 'ConnectorObject' based on the attributes and Uid provided.