org.forgerock.opendj.ldap

Class Functions

java.lang.Object

org.forgerock.opendj.ldap.Functions

public final class Functions
extends Object

Common Function implementations which may be used when parsing attributes.

See Also:

Entry.parseAttribute(org.forgerock.opendj.ldap.AttributeDescription), Attribute.parse(), AttributeParser

Method Summary

Modifier and Type	Method and Description
static AttributeDescription	byteStringToAttributeDescription(ByteString value, Schema schema) Parses a ByteString as an AttributeDescription using the provided schema.
static Function<ByteString,Boolean,LocalizedIllegalArgumentException>	byteStringToBoolean() Returns a function which parses Boolean values.
static X509Certificate	byteStringToCertificate(ByteString value) Parses a ByteString as a X509Certificate.
static Function<ByteString,Dn,LocalizedIllegalArgumentException>	byteStringToDn() Returns a function which parses DNs using the default schema.
static Function<ByteString,Dn,LocalizedIllegalArgumentException>	byteStringToDn(Schema schema) Returns a function which parses DNs using the provided schema.
static Function<ByteString,GeneralizedTime,LocalizedIllegalArgumentException>	byteStringToGeneralizedTime() Returns a function which parses generalized time strings.
static Function<ByteString,Integer,LocalizedIllegalArgumentException>	byteStringToInteger() Returns a function which parses Integer string values.
static Function<ByteString,Long,LocalizedIllegalArgumentException>	byteStringToLong() Returns a function which parses Long string values.
static <M,N> Function<M,N,NeverThrowsException>	constant(N constant) Creates a function that returns constant value for any input.
static <M> M	identity(M value) Returns the provided value.
static boolean	stringToBoolean(String value) Parses a String as a boolean.
static int	stringToInteger(String value) Parses a String as an int.
static long	stringToLong(String value) Parses a String as a long.

Methods inherited from class java.lang.Object

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

Method Detail

constant

public static <M,N> Function<M,N,NeverThrowsException> constant(N constant)

Creates a function that returns constant value for any input.

Type Parameters:

M - The type of input values transformed by this function.

N - The type of output values returned by this function.

Parameters:

constant - The constant value for the function to return

Returns:

A function that always returns constant value.

identity

public static <M> M identity(M value)

Returns the provided value.

Type Parameters:

M - The type of value returned by this function.

Parameters:

value - The value to be returned.

Returns:

The provided value.

stringToBoolean

public static boolean stringToBoolean(String value)

Parses a String as a boolean. The method will accept the values 0, false, no, off, 1, true, yes, on. All other values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

Returns:

The parsed boolean.

stringToInteger

public static int stringToInteger(String value)

Parses a String as an int. Invalid values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

Returns:

The parsed int.

stringToLong

public static long stringToLong(String value)

Parses a String as a long. Invalid values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

Returns:

The parsed long.

byteStringToAttributeDescription

public static AttributeDescription byteStringToAttributeDescription(ByteString value,
                                                                    Schema schema)

Parses a ByteString as an AttributeDescription using the provided schema. Invalid values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

schema - The schema to use for decoding attribute descriptions.

Returns:

The parsed AttributeDescriptions.

byteStringToBoolean

public static Function<ByteString,Boolean,LocalizedIllegalArgumentException> byteStringToBoolean()

Returns a function which parses Boolean values. The function will accept the values 0, false, no, off, 1, true, yes, on. All other values will result in a LocalizedIllegalArgumentException.

Returns:

A function which parses Boolean values.

byteStringToDn

public static Function<ByteString,Dn,LocalizedIllegalArgumentException> byteStringToDn()

Returns a function which parses DNs using the default schema. Invalid values will result in a LocalizedIllegalArgumentException .

Returns:

A function which parses DNs.

byteStringToDn

public static Function<ByteString,Dn,LocalizedIllegalArgumentException> byteStringToDn(Schema schema)

Returns a function which parses DNs using the provided schema. Invalid values will result in a LocalizedIllegalArgumentException .

Parameters:

schema - The schema to use for decoding DNs.

Returns:

A function which parses DNs.

byteStringToCertificate

public static X509Certificate byteStringToCertificate(ByteString value)

Parses a ByteString as a X509Certificate. Invalid values will result in a LocalizedIllegalArgumentException.

Parameters:

value - The value to be parsed.

Returns:

The parsed X509Certificate.

byteStringToGeneralizedTime

public static Function<ByteString,GeneralizedTime,LocalizedIllegalArgumentException> byteStringToGeneralizedTime()

Returns a function which parses generalized time strings. Invalid values will result in a LocalizedIllegalArgumentException.

Returns:

A function which parses generalized time strings.

byteStringToInteger

public static Function<ByteString,Integer,LocalizedIllegalArgumentException> byteStringToInteger()

Returns a function which parses Integer string values. Invalid values will result in a LocalizedIllegalArgumentException.

Returns:

A function which parses Integer string values.

byteStringToLong

public static Function<ByteString,Long,LocalizedIllegalArgumentException> byteStringToLong()

Returns a function which parses Long string values. Invalid values will result in a LocalizedIllegalArgumentException.

Returns:

A function which parses Long string values.