org.apache.directory.api.ldap.model.name

Class Ava

java.lang.Object

org.apache.directory.api.ldap.model.name.Ava

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Comparable<Ava>

public class Ava
extends Object
implements Externalizable, Cloneable, Comparable<Ava>

A Attribute Type And Value, which is the basis of all Rdn. It contains a type, and a value. The type must not be case sensitive. Superfluous leading and trailing spaces MUST have been trimmed before. The value MUST be in UTF8 format, according to RFC 2253. If the type is in OID form, then the value must be a hexadecimal string prefixed by a '#' character. Otherwise, the string must respect the RC 2253 grammar. We will also keep a User Provided form of the AVA (Attribute Type And Value), called upName.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private AttributeType	attributeType The attributeType if the Ava is schemaAware
private int	h The computed hashcode
private static org.slf4j.Logger	LOG The LoggerFactory used by this class
private String	normType The normalized Name type
private SchemaManager	schemaManager the schema manager
private static long	serialVersionUID Declares the Serial Version Uid.
private String	upName The user provided Ava
private String	upType The user provided Name type
private Value<?>	value The value.

Constructor Summary

Constructors

Constructor and Description
Ava() Constructs an empty Ava
Ava(AttributeType attributeType, String upType, String normType, Value<?> value, String upName) Construct an Ava.
Ava(SchemaManager schemaManager) Constructs an empty schema aware Ava.
Ava(SchemaManager schemaManager, String upType, byte[] upValue) Construct a schema aware Ava containing a binary value.
Ava(SchemaManager schemaManager, String upType, String upValue) Construct a schema aware Ava with a String value.
Ava(SchemaManager schemaManager, String upType, String normType, Value<?> value) Construct an Ava.
Ava(String upType, byte[] upValue) Construct an Ava containing a binary value.
Ava(String upType, String upValue) Construct an Ava with a String value.
Ava(String upType, String normType, Value<?> value, String upName) Construct an Ava.

Method Summary

Modifier and Type	Method and Description
void	apply(SchemaManager schemaManager) Apply a SchemaManager to the Ava.
Ava	clone() Implements the cloning.
int	compareTo(Ava that)
private int	compareValues(Ava that)
private void	createAva(SchemaManager schemaManager, String upType, Value<?> value) Construct a schema aware Ava.
private void	createAva(String upType, Value<?> upValue) Construct an Ava.
int	deserialize(byte[] buffer, int pos) Deserialize an AVA from a byte[], starting at a given position
boolean	equals(Object obj)
AttributeType	getAttributeType()
String	getName() Get the user provided form of this attribute type and value
String	getNormName() Get the normalized Name of a Ava
String	getNormType() Get the normalized type of a Ava
String	getType() Get the user provided type of a Ava
Value<?>	getValue() Get the Value of a Ava
int	hashCode() Gets the hashcode of this object.
boolean	isSchemaAware() Tells if the Ava is schema aware or not.
String	normalize() A Normalized String representation of a Ava : type is trimed and lowercased value is trimed and lowercased, and special characters are escaped if needed.
void	readExternal(ObjectInput in) We read back the data to create a new ATAV.
int	serialize(byte[] buffer, int pos) Serialize the AVA into a buffer at the given position.
String	toString() A String representation of an Ava, as provided by the user.
void	writeExternal(ObjectOutput out) An Ava is composed of a type and a value.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Declares the Serial Version Uid.

See Also:

Always Declare Serial Version Uid, Constant Field Values

LOG

private static final org.slf4j.Logger LOG

The LoggerFactory used by this class

normType

private String normType

The normalized Name type

upType

private String upType

The user provided Name type

value

private Value<?> value

The value. It can be a String or a byte array

upName

private String upName

The user provided Ava

attributeType

private AttributeType attributeType

The attributeType if the Ava is schemaAware

schemaManager

private SchemaManager schemaManager

the schema manager

h

private volatile int h

The computed hashcode

Constructor Detail

Ava

public Ava()

Constructs an empty Ava

Ava

public Ava(SchemaManager schemaManager)

Constructs an empty schema aware Ava.

Parameters:

schemaManager - The SchemaManager instance

Ava

public Ava(String upType,
           byte[] upValue)
    throws LdapInvalidDnException

Construct an Ava containing a binary value.

Note that the upValue should not be null or empty, or resolve to an empty string after having trimmed it.

Parameters:

upType - The User Provided type

upValue - The User Provided binary value

Throws:

LdapInvalidDnException - If the given type or value are invalid

Ava

public Ava(SchemaManager schemaManager,
           String upType,
           byte[] upValue)
    throws LdapInvalidDnException

Construct a schema aware Ava containing a binary value. The AttributeType and value will be normalized accordingly to the given SchemaManager.

Note that the upValue should not be null or empty, or resolve to an empty string after having trimmed it.

Parameters:

schemaManager - The SchemaManager instance

upType - The User Provided type

upValue - The User Provided binary value

Throws:

LdapInvalidDnException - If the given type or value are invalid

Ava

public Ava(String upType,
           String upValue)
    throws LdapInvalidDnException

Construct an Ava with a String value.

Note that the upValue should not be null or empty, or resolve to an empty string after having trimmed it.

Parameters:

upType - The User Provided type

upValue - The User Provided String value

Throws:

LdapInvalidDnException - If the given type or value are invalid

Ava

public Ava(SchemaManager schemaManager,
           String upType,
           String upValue)
    throws LdapInvalidDnException

Construct a schema aware Ava with a String value.

Note that the upValue should not be null or empty, or resolve to an empty string after having trimmed it.

Parameters:

schemaManager - The SchemaManager instance

upType - The User Provided type

upValue - The User Provided String value

Throws:

LdapInvalidDnException - If the given type or value are invalid

Ava

Ava(SchemaManager schemaManager,
    String upType,
    String normType,
    Value<?> value)
throws LdapInvalidDnException

Construct an Ava. The type and value are normalized :

the type is trimmed and lowercased the value is trimmed

Note that the upValue should not be null or empty, or resolved to an empty string after having trimmed it.

Parameters:

schemaManager - The SchemaManager

upType - The User Provided type

normType - The normalized type

value - The value

Throws:

LdapInvalidDnException - If the given type or value are invalid

Ava

Ava(String upType,
    String normType,
    Value<?> value,
    String upName)
throws LdapInvalidDnException

Construct an Ava. The type and value are normalized :

the type is trimmed and lowercased the value is trimmed

Note that the upValue should not be null or empty, or resolved to an empty string after having trimmed it.