StringValue (Apache Directory LDAP API Model 1.0.0 API)

java.lang.Object
- org.apache.directory.api.ldap.model.entry.AbstractValue<String>
- - org.apache.directory.api.ldap.model.entry.StringValue

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Comparable<Value<String>>, Value<String>
```
public class StringValue
extends AbstractValue<String>
```
A server side schema aware wrapper around a String attribute value. This value wrapper uses schema information to syntax check values, and to compare them for equality and ordering. It caches results and invalidates them when the user provided value changes.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

private byte[] bytes
The UTF-8 bytes for this value

private static long serialVersionUID
Used for serialization
- Fields inherited from class org.apache.directory.api.ldap.model.entry.AbstractValue
  attributeType, h, LOG, normalizedValue, upValue
- Fields inherited from interface org.apache.directory.api.ldap.model.entry.Value
  BINARY, STRING

Fields
Modifier and Type	Field and Description
`private byte[]`	`bytes` The UTF-8 bytes for this value
`private static long`	`serialVersionUID` Used for serialization

Constructor Summary

Constructors
Constructor and Description
`StringValue(AttributeType attributeType)` Creates a StringValue without an initial user provided value.
`StringValue(AttributeType attributeType, String value)` Creates a schema aware StringValue with an initial user provided String value.
`StringValue(AttributeType attributeType, String value, String normValue)` Creates a schema aware StringValue with an initial user provided String value.
`StringValue(String value)` Creates a StringValue with an initial user provided String value.
`StringValue(String value, String normalizedValue)` Creates a StringValue with an initial user provided String value and a normalized value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringValue`	`clone()` Clone a Value
`int`	`compareTo(Value<String> value)` Compare the current value with a given value
`static StringValue`	`deserialize(AttributeType attributeType, ObjectInput in)` Deserialize a schemaAware StringValue.
`int`	`deserialize(byte[] buffer, int pos)` Deserialize a StringValue from a byte[], starting at a given position
`static StringValue`	`deserialize(ObjectInput in)` Deserialize a StringValue.
`boolean`	`equals(Object obj)` Two StringValue are equals if their normalized values are equal
`byte[]`	`getBytes()` Get the user provided value as a byte[].
`String`	`getNormValue()` Gets the normalized (canonical) representation for the wrapped string.
`String`	`getString()` Get the user provided value as a String.
`String`	`getValue()` Get the User Provided value.
`int`	`hashCode()`
`boolean`	`isHumanReadable()` Tells if the current value is Human Readable
`int`	`length()`
`void`	`readExternal(ObjectInput in)`
`int`	`serialize(byte[] buffer, int pos)` Serialize the StringValue into a buffer at the given position.
`String`	`toString()`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class org.apache.directory.api.ldap.model.entry.AbstractValue
apply, getAttributeType, getLdapComparator, getNormReference, getReference, isInstanceOf, isNull, isSchemaAware, isValid

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    Used for serialization
    
    See Also:
    
    Constant Field Values
  - bytes
```
private byte[] bytes
```
    The UTF-8 bytes for this value
- Constructor Detail
  - StringValue
```
public StringValue(AttributeType attributeType)
```
    Creates a StringValue without an initial user provided value.
    
    Parameters:
    
    attributeType - the schema attribute type associated with this StringValue
  - StringValue
```
public StringValue(String value)
```
    Creates a StringValue with an initial user provided String value.
    
    Parameters:
    
    value - the value to wrap which can be null
  - StringValue
```
public StringValue(String value,
                   String normalizedValue)
```
    Creates a StringValue with an initial user provided String value and a normalized value.
    
    Parameters:
    
    value - the user provided value to wrap which can be null
    
    normalizedValue - the normalized value to wrap which can be null
  - StringValue
```
public StringValue(AttributeType attributeType,
                   String value)
            throws LdapInvalidAttributeValueException
```
    Creates a schema aware StringValue with an initial user provided String value.
    
    Parameters:
    
    attributeType - the schema type associated with this StringValue
    
    value - the value to wrap
    
    Throws:
    
    LdapInvalidAttributeValueException - If the added value is invalid accordingly to the schema
  - StringValue
```
public StringValue(AttributeType attributeType,
                   String value,
                   String normValue)
            throws LdapInvalidAttributeValueException
```
    Creates a schema aware StringValue with an initial user provided String value.
    
    Parameters:
    
    attributeType - the schema type associated with this StringValue
    
    value - the value to wrap
    
    normValue - The normalized form to store
    
    Throws:
    
    LdapInvalidAttributeValueException - If the added value is invalid accordingly to the schema
- Method Detail
  - getValue
```
public String getValue()
```
    Get the User Provided value. It will return a copy, not a reference.
    
    Returns:
    
    a copy of the wrapped value
  - getNormValue
```
public String getNormValue()
```
    Gets the normalized (canonical) representation for the wrapped string. If the wrapped String is null, null is returned, otherwise the normalized form is returned. If the normalizedValue is null, then this method will attempt to generate it from the wrapped value.
    
    Returns:
    
    gets the normalized value
  - compareTo
```
public int compareTo(Value<String> value)
```
    Compare the current value with a given value
    
    Parameters:
    
    value - The Value to compare to
    
    Returns:
    
    -1 if the current value is below the given value, 1 if it's abobe, 0 if it's equal
    
    Throws:
    
    IllegalStateException - on failures to extract the comparator, or the normalizers needed to perform the required comparisons based on the schema
  - clone
```
public StringValue clone()
```
    Clone a Value
    
    Specified by:
    
    clone in interface Value<String>
    
    Overrides:
    
    clone in class AbstractValue<String>
    
    Returns:
    
    A cloned value
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the instance's hashcode
    
    See Also:
    
    Object.hashCode()
  - equals
```
public boolean equals(Object obj)
```
    Two StringValue are equals if their normalized values are equal
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(Object)
  - isHumanReadable
```
public boolean isHumanReadable()
```
    Tells if the current value is Human Readable
    
    Returns:
    
    true if the value is a String, false otherwise
  - length
```
public int length()
```
    Returns:
    
    The length of the interned value
  - getBytes
```
public byte[] getBytes()
```
    Get the user provided value as a byte[].
    
    Specified by:
    
    getBytes in interface Value<String>
    
    Overrides:
    
    getBytes in class AbstractValue<String>
    
    Returns:
    
    the user provided value as a byte[]
  - getString
```
public String getString()
```
    Get the user provided value as a String.
    
    Specified by:
    
    getString in interface Value<String>
    
    Overrides:
    
    getString in class AbstractValue<String>
    
    Returns:
    
    the user provided value as a String
  - deserialize
```
public static StringValue deserialize(ObjectInput in)
                               throws IOException,
                                      ClassNotFoundException
```
    Deserialize a StringValue. It will return a new StringValue instance.
    
    Parameters:
    
    in - The input stream
    
    Returns:
    
    A new StringValue instance
    
    Throws:
    
    IOException - If the stream can't be read
    
    ClassNotFoundException - If we can't instanciate a StringValue
  - deserialize
```
public static StringValue deserialize(AttributeType attributeType,
                                      ObjectInput in)
                               throws IOException,
                                      ClassNotFoundException
```
    Deserialize a schemaAware StringValue. It will return a new StringValue instance.
    
    Parameters:
    
    attributeType - The AttributeType associated with the Value. Can be null
    
    in - The input stream
    
    Returns:
    
    A new StringValue instance
    
    Throws:
    
    IOException - If the stream can't be read
    
    ClassNotFoundException - If we can't instanciate a StringValue
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException
  - serialize
```
public int serialize(byte[] buffer,
                     int pos)
```
    Serialize the StringValue into a buffer at the given position.
    
    Parameters:
    
    buffer - The buffer which will contain the serialized StringValue
    
    pos - The position in the buffer for the serialized value
    
    Returns:
    
    The new position in the buffer
  - deserialize
```
public int deserialize(byte[] buffer,
                       int pos)
                throws IOException
```
    Deserialize a StringValue from a byte[], starting at a given position
    
    Parameters:
    
    buffer - The buffer containing the StringValue
    
    pos - The position in the buffer
    
    Returns:
    
    The new position
    
    Throws:
    
    IOException - If the serialized value is not a StringValue
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class StringValue

Field Summary

Fields inherited from class org.apache.directory.api.ldap.model.entry.AbstractValue

Fields inherited from interface org.apache.directory.api.ldap.model.entry.Value

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.api.ldap.model.entry.AbstractValue

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

bytes

Constructor Detail

StringValue

StringValue

StringValue

StringValue

StringValue

Method Detail

getValue

getNormValue

compareTo

clone

hashCode

equals

isHumanReadable

length

getBytes

getString

deserialize

deserialize

readExternal

serialize

deserialize

writeExternal

toString