C# Class Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder

Simplifies the process of building 'AttributeInfo' objects.

This class is responsible for providing a default implementation of ConnectorAttributeInfo. AttributeInfoBuilder bld = new AttributeInfoBuilder("email"); bld.setRequired(true); AttributeInfo info = bld.build();

Mostrar archivo Open project: Tirasa/ConnId Class Usage Examples

Public Methods

Method	Description
Build ( ) : ConnectorAttributeInfo	Builds an ConnectorAttributeInfo object based on the properties set.
Build ( String name ) : ConnectorAttributeInfo	Convenience method to create an AttributeInfo. Equivalent to `AttributeInfoBuilder.build(name,type)`
Build ( String name, Type type ) : ConnectorAttributeInfo	Convenience method to create an AttributeInfo. Equivalent to `AttributeInfoBuilder.build(name,type,null)`
Build ( String name, Type type, ConnectorAttributeInfo flags ) : ConnectorAttributeInfo	Convenience method to create an AttributeInfo. Equivalent to `new AttributeInfoBuilder(name,type).setFlags(flags).build()`
ConnectorAttributeInfoBuilder ( ) : System	Creates an builder with all the defaults set. The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown. Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
ConnectorAttributeInfoBuilder ( String name ) : System	Creates an builder with all the defaults set. The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown. Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
ConnectorAttributeInfoBuilder ( String name, Type type ) : System	Creates an builder with all the defaults set. The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown. Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false
Define ( string name ) : ConnectorAttributeInfoBuilder	Convenience method to create a new AttributeInfoBuilder. Equivalent to: `new AttributeInfoBuilder(name, String.class)` Since 1.4
Define ( string name, Type type ) : ConnectorAttributeInfoBuilder	Convenience method to create a new AttributeInfoBuilder. Equivalent to: `new AttributeInfoBuilder(name, type)` Since 1.4
SetCreatable ( bool value ) : ConnectorAttributeInfoBuilder	Determines if the attribute is writable.
SetMultiValued ( bool value ) : ConnectorAttributeInfoBuilder	Determines if this attribute supports multivalue.
SetName ( string name ) : ConnectorAttributeInfoBuilder	Sets the unique name of the ConnectorAttributeInfo object.
SetReadable ( bool value ) : ConnectorAttributeInfoBuilder	Determines if the attribute is readable.
SetRequired ( bool value ) : ConnectorAttributeInfoBuilder	Determines if this attribute is required.
SetReturnedByDefault ( bool value ) : ConnectorAttributeInfoBuilder
SetUpdateable ( bool value ) : ConnectorAttributeInfoBuilder	Determines if this attribute writable during update.
SetValueType ( Type type ) : ConnectorAttributeInfoBuilder	Please see FrameworkUtil.CheckAttributeType(Type) for the definitive list of supported types.

Private Methods

Method	Description
SetFlag ( ConnectorAttributeInfo flag, bool value ) : void

Method Details

Build() public method

Builds an ConnectorAttributeInfo object based on the properties set.

public Build ( ) : ConnectorAttributeInfo
return	ConnectorAttributeInfo

Build() public static method

Convenience method to create an AttributeInfo.

Equivalent to AttributeInfoBuilder.build(name,type)

public static Build ( String name ) : ConnectorAttributeInfo
name	String	The name of the attribute
return	ConnectorAttributeInfo

Build() public static method

Convenience method to create an AttributeInfo.

Equivalent to AttributeInfoBuilder.build(name,type,null)

public static Build ( String name, Type type ) : ConnectorAttributeInfo
name	String	The name of the attribute
type	System.Type	The type of the attribute
return	ConnectorAttributeInfo

Build() public static method

Convenience method to create an AttributeInfo.

Equivalent to new AttributeInfoBuilder(name,type).setFlags(flags).build()

public static Build ( String name, Type type, ConnectorAttributeInfo flags ) : ConnectorAttributeInfo
name	String	The name of the attribute
type	System.Type	The type of the attribute
flags	ConnectorAttributeInfo	The flags for the attribute. Null means clear all flags
return	ConnectorAttributeInfo

ConnectorAttributeInfoBuilder() public method

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

 Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false

public ConnectorAttributeInfoBuilder ( ) : System
return	System

ConnectorAttributeInfoBuilder() public method

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

 Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false

public ConnectorAttributeInfoBuilder ( String name ) : System
name	String
return	System

ConnectorAttributeInfoBuilder() public method

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

 Name: <not set> Readable: true Writeable: true Required: false Type: string MultiValue: false

public ConnectorAttributeInfoBuilder ( String name, Type type ) : System
name	String
type	System.Type
return	System

Define() public static method

Convenience method to create a new AttributeInfoBuilder. Equivalent to: new AttributeInfoBuilder(name, String.class)

Since 1.4

public static Define ( string name ) : ConnectorAttributeInfoBuilder
name	string	/// The name of the attribute
return	ConnectorAttributeInfoBuilder

Define() public static method

Convenience method to create a new AttributeInfoBuilder. Equivalent to: new AttributeInfoBuilder(name, type)

Since 1.4

public static Define ( string name, Type type ) : ConnectorAttributeInfoBuilder
name	string	/// The name of the attribute
type	System.Type	/// The type of the attribute
return	ConnectorAttributeInfoBuilder

SetCreatable() public method

Determines if the attribute is writable.

public SetCreatable ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetMultiValued() public method

Determines if this attribute supports multivalue.

public SetMultiValued ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetName() public method

Sets the unique name of the ConnectorAttributeInfo object.

public SetName ( string name ) : ConnectorAttributeInfoBuilder
name	string	unique name of the object.
return	ConnectorAttributeInfoBuilder

SetReadable() public method

Determines if the attribute is readable.

public SetReadable ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetRequired() public method

Determines if this attribute is required.

public SetRequired ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetReturnedByDefault() public method

public SetReturnedByDefault ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetUpdateable() public method

Determines if this attribute writable during update.

public SetUpdateable ( bool value ) : ConnectorAttributeInfoBuilder
value	bool
return	ConnectorAttributeInfoBuilder

SetValueType() public method

Please see FrameworkUtil.CheckAttributeType(Type) for the definitive list of supported types.

if the Class is not a supported type.

public SetValueType ( Type type ) : ConnectorAttributeInfoBuilder
type	System.Type	type for an 's value.
return	ConnectorAttributeInfoBuilder