org.apache.directory.shared.ldap.name
Class AVA

java.lang.Object
  org.apache.directory.shared.ldap.name.AVA

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Comparable

public class AVA
extends Object
implements Cloneable, Comparable, Externalizable

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. No further normalization will be done, because we don't have any knowledge of the Schema definition in the parser. We will also keep a User Provided form of the atav (Attribute Type And Value), called upName.

Version:

$Rev: 912436 $, $Date: 2010-02-22 00:16:28 +0100 (Lun, 22 fév 2010) $

Author:

Apache Directory Project

See Also:

Serialized Form

Constructor Summary

AVA()
Construct an empty AVA

AVA(String upType, String normType, byte[] upValue, byte[] normValue)
Construct an AVA.

AVA(String upType, String normType, String upValue, String normValue)
Construct an AVA.

AVA(String upType, String normType, Value<?> upValue, Value<?> normValue)
Construct an AVA.

AVA(String upType, String normType, Value<?> upValue, Value<?> normValue, String upName)
Construct an AVA.

Method Summary

Object	clone() Implements the cloning.
int	compareTo(Object object) Compares two NameComponents.
int	compareToIgnoreCase(Object object) Compares two NameComponents.
boolean	equals(Object obj)
int	getLength() Get the upName length
String	getNormName() Get the normalized Name of a AVA
String	getNormType() Get the normalized type of a AVA
Value<?>	getNormValue() Get the Value of a AVA
int	getStart() get the position in the original upName where this atav starts.
String	getUpName() Get the user provided form of this attribute type and value
String	getUpType() Get the user provided type of a AVA
Value<?>	getUpValue() Get the User Provided Value of a AVA
int	hashCode() Gets the hashcode of this object.
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.
String	normalizeValue()
void	readExternal(ObjectInput in)
void	setType(String upType, String type) Store a new type
void	setTypeNormalized(String type) Store the type, after having trimmed and lowercased it.
void	setValue(Value<?> upValue, Value<?> normValue) Store the value of a AVA.
void	setValueNormalized(String value) Store the value of a AVA, after having trimmed it.
String	toString() A String representation of a AVA.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

AVA

public AVA()

Construct an empty AVA

AVA

public AVA(String upType,
           String normType,
           String upValue,
           String normValue)
    throws InvalidNameException

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:

upType - The Usrr Provided type

normType - The normalized type

upValue - The User Provided value

normValue - The normalized value

Throws:

InvalidNameException

AVA

public AVA(String upType,
           String normType,
           byte[] upValue,
           byte[] normValue)
    throws InvalidNameException

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:

upType - The Usrr Provided type

normType - The normalized type

upValue - The User Provided value

normValue - The normalized value

Throws:

InvalidNameException

AVA

public AVA(String upType,
           String normType,
           Value<?> upValue,
           Value<?> normValue)
    throws InvalidNameException

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:

upType - The Usrr Provided type

normType - The normalized type

upValue - The User Provided value

normValue - The normalized value

Throws:

InvalidNameException

AVA

public AVA(String upType,
           String normType,
           Value<?> upValue,
           Value<?> normValue,
           String upName)
    throws InvalidNameException

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:

upType - The User Provided type

normType - The normalized type

upValue - The User Provided value

normValue - The normalized value

upName - The User Provided name (may be escaped)

Throws:

InvalidNameException

Method Detail

getNormType

public String getNormType()

Get the normalized type of a AVA

Returns:

The normalized type

getUpType

public String getUpType()

Get the user provided type of a AVA

Returns:

The user provided type

setType

public void setType(String upType,
                    String type)
             throws InvalidNameException

Store a new type

Parameters:

upType - The AVA User Provided type

type - The AVA type

Throws:

InvalidNameException - if the type or upType are empty or null. If the upName is invalid.

setTypeNormalized

public void setTypeNormalized(String type)
                       throws InvalidNameException

Store the type, after having trimmed and lowercased it.

Parameters:

type - The AVA type

Throws:

InvalidNameException

getNormValue

public Value<?> getNormValue()

Get the Value of a AVA

Returns:

The value

getUpValue

public Value<?> getUpValue()

Get the User Provided Value of a AVA

Returns:

The value

getNormName

public String getNormName()

Get the normalized Name of a AVA

Returns:

The name

setValue

public void setValue(Value<?> upValue,
                     Value<?> normValue)

Store the value of a AVA.

Parameters:

value - The user provided value of the AVA

normValue - The normalized value

getLength

public int getLength()

Get the upName length

Returns:

the upName length

getStart

public int getStart()

get the position in the original upName where this atav starts.

Returns:

The starting position of this atav

getUpName

public String getUpName()

Get the user provided form of this attribute type and value

Returns:

The user provided form of this atav

setValueNormalized

public void setValueNormalized(String value)

Store the value of a AVA, after having trimmed it.

Parameters:

value - The value of the AVA

clone

public Object clone()

Implements the cloning.

Overrides:

clone in class Object

Returns:

a clone of this object

compareTo

public int compareTo(Object object)

Compares two NameComponents. They are equals if : - types are equals, case insensitive, - values are equals, case sensitive

Specified by:

compareTo in interface Comparable

Parameters:

object -

Returns:

0 if both NC are equals, otherwise a positive value if the original NC is superior to the second one, a negative value if the second NC is superior.

compareToIgnoreCase

public int compareToIgnoreCase(Object object)

Compares two NameComponents. They are equals if : - types are equals, case insensitive, - values are equals, case insensitive

Parameters:

object -

Returns:

0 if both NC are equals, otherwise a positive value if the original NC is superior to the second one, a negative value if the second NC is superior.

normalizeValue

public String normalizeValue()

normalize

public 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.

Returns:

A normalized string representing a AVA

hashCode

public int hashCode()

Gets the hashcode of this object.

Overrides:

hashCode in class Object

Returns:

The instance hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

See Also:

An AVA is composed of a type and a value. The data are stored following the structure :

upName

The User provided ATAV

start

The position of this ATAV in the DN

length

The ATAV length

upType

The user Provided Type

normType

The normalized AttributeType

isHR

Tells if the value is a String or not

if the value is a String :

upValue

The User Provided value.

value

The normalized value.

if the value is binary :

upValueLength

upValue

The User Provided value.

valueLength

value

The normalized value.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

See Also:

We read back the data to create a new ATAV. The structure read is exposed in the {@link AVA#writeExternal(ObjectOutput)} method

toString

public String toString()

A String representation of a AVA.

Overrides:

toString in class Object

Returns:

A string representing a AVA