Package com.unboundid.util
Class OID
- java.lang.Object
-
- com.unboundid.util.OID
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<OID>
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class OID extends java.lang.Object implements java.io.Serializable, java.lang.Comparable<OID>
This class provides a data structure that may be used for representing object identifiers. Since some directory servers support using strings that aren't valid object identifiers where OIDs are required, this implementation supports arbitrary strings, but some methods may only be available for valid OIDs.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description OID(int... components)
Creates a new OID object from the provided set of numeric components.OID(OID parentOID, int childComponent)
Creates a new OID that is a child of the provided parent OID.OID(java.lang.String oidString)
Creates a new OID object from the provided string representation.OID(java.util.List<java.lang.Integer> components)
Creates a new OID object from the provided set of numeric components.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(OID oid)
Indicates the position of the provided object relative to this OID in a sorted list.boolean
equals(java.lang.Object o)
Indicates whether the provided object is equal to this OID.java.util.List<java.lang.Integer>
getComponents()
Retrieves the numeric components that comprise this OID.OID
getParent()
Retrieves the OID that is the parent for this OID.int
hashCode()
Retrieves a hash code for this OID.boolean
isAncestorOf(OID oid)
Indicates whether this OID is an ancestor of the provided OID.boolean
isDescendantOf(OID oid)
Indicates whether this OID is a descendant of the provided OID.boolean
isStrictlyValidNumericOID()
Indicates whether this object represents a strictly valid numeric OID.static boolean
isStrictlyValidNumericOID(java.lang.String s)
Indicates whether this object represents a strictly valid numeric OID.boolean
isValidNumericOID()
Indicates whether the provided string represents a valid numeric OID.static boolean
isValidNumericOID(java.lang.String s)
Indicates whether the provided string represents a valid numeric OID.static java.util.List<java.lang.Integer>
parseComponents(java.lang.String oidString)
Parses the provided string as a numeric OID and extracts the numeric components from it.static OID
parseNumericOID(java.lang.String oidString, boolean strict)
Parses the provided string as a numeric OID, optionally using additional strict validation.java.lang.String
toString()
Retrieves a string representation of this OID.
-
-
-
Constructor Detail
-
OID
public OID(@Nullable java.lang.String oidString)
Creates a new OID object from the provided string representation.- Parameters:
oidString
- The string to use to create this OID.
-
OID
public OID(@Nullable int... components)
Creates a new OID object from the provided set of numeric components. At least one component must be provided for a valid OID.- Parameters:
components
- The numeric components to include in the OID.
-
OID
public OID(@Nullable java.util.List<java.lang.Integer> components)
Creates a new OID object from the provided set of numeric components. At least one component must be provided for a valid OID.- Parameters:
components
- The numeric components to include in the OID.
-
OID
public OID(@NotNull OID parentOID, int childComponent) throws java.text.ParseException
Creates a new OID that is a child of the provided parent OID.- Parameters:
parentOID
- The parent OID below which the child should be created. It must not benull
, and it must be a valid numeric OID.childComponent
- The integer value for the child component.- Throws:
java.text.ParseException
- If the provided parent OID is not a valid numeric OID.
-
-
Method Detail
-
parseComponents
@Nullable public static java.util.List<java.lang.Integer> parseComponents(@Nullable java.lang.String oidString)
Parses the provided string as a numeric OID and extracts the numeric components from it.- Parameters:
oidString
- The string to parse as a numeric OID.- Returns:
- The numeric components extracted from the provided string, or
null
if the provided string does not represent a valid numeric OID.
-
parseNumericOID
@NotNull public static OID parseNumericOID(@Nullable java.lang.String oidString, boolean strict) throws java.text.ParseException
Parses the provided string as a numeric OID, optionally using additional strict validation.- Parameters:
oidString
- The string to be parsed as a numeric OID. It must not benull
.strict
- Indicates whether to use strict validation. If this isfalse
, then the method will verify that the provided string is made up of a dotted list of numbers that does not start or end with a period and does not contain consecutive periods. If this istrue
, then it will additional verify that the OID contains at least two components, that the value of the first component is not greater than two, and that the value of the second component is not greater than 39 if the value of the first component is zero or one.- Returns:
- The OID that was parsed from the provided string.
- Throws:
java.text.ParseException
- If the provided string cannot be parsed as a valid numeric OID.
-
isValidNumericOID
public static boolean isValidNumericOID(@Nullable java.lang.String s)
Indicates whether the provided string represents a valid numeric OID. Note this this method only ensures that the value is made up of a dotted list of numbers that does not start or end with a period and does not contain two consecutive periods. TheisStrictlyValidNumericOID(String)
method performs additional validation, including ensuring that the OID contains at least two components, that the value of the first component is not greater than two, and that the value of the second component is not greater than 39 if the value of the first component is zero or one.- Parameters:
s
- The string for which to make the determination.- Returns:
true
if the provided string represents a valid numeric OID, orfalse
if not.
-
isValidNumericOID
public boolean isValidNumericOID()
Indicates whether the provided string represents a valid numeric OID. Note this this method only ensures that the value is made up of a dotted list of numbers that does not start or end with a period and does not contain two consecutive periods. TheisStrictlyValidNumericOID()
method performs additional validation, including ensuring that the OID contains at least two components, that the value of the first component is not greater than two, and that the value of the second component is not greater than 39 if the value of the first component is zero or one.- Returns:
true
if this object represents a valid numeric OID, orfalse
if not.
-
isStrictlyValidNumericOID
public static boolean isStrictlyValidNumericOID(@Nullable java.lang.String s)
Indicates whether this object represents a strictly valid numeric OID. In addition to ensuring that the value is made up of a dotted list of numbers that does not start or end with a period or contain two consecutive periods, this method also ensures that the OID contains at least two components, that the value of the first component is not greater than two, and that the value of the second component is not greater than 39 if the value of the first component is zero or one.- Parameters:
s
- The string for which to make the determination.- Returns:
true
if this object represents a strictly valid numeric OID, orfalse
if not.
-
isStrictlyValidNumericOID
public boolean isStrictlyValidNumericOID()
Indicates whether this object represents a strictly valid numeric OID. In addition to ensuring that the value is made up of a dotted list of numbers that does not start or end with a period or contain two consecutive periods, this method also ensures that the OID contains at least two components, that the value of the first component is not greater than two, and that the value of the second component is not greater than 39 if the value of the first component is zero or one.- Returns:
true
if this object represents a strictly valid numeric OID, orfalse
if not.
-
getComponents
@Nullable public java.util.List<java.lang.Integer> getComponents()
Retrieves the numeric components that comprise this OID. This will only return a non-null
value ifisValidNumericOID(java.lang.String)
returnstrue
.- Returns:
- The numeric components that comprise this OID, or
null
if this object does not represent a valid numeric OID.
-
getParent
@Nullable public OID getParent() throws java.text.ParseException
Retrieves the OID that is the parent for this OID. This OID must represent a valid numeric OID.- Returns:
- The OID that is the parent for this OID, or
null
if this OID doesn't have a parent. Note that the returned OID may not necessarily be strictly valid in some cases (for example, if this OID only contains two components, as all strictly valid OIDs must contain at least two components). - Throws:
java.text.ParseException
- If this OID does not represent a valid numeric OID.
-
isAncestorOf
public boolean isAncestorOf(@NotNull OID oid) throws java.text.ParseException
Indicates whether this OID is an ancestor of the provided OID. This OID will be considered an ancestor of the provided OID if the provided OID has more components than this OID, and if the components that comprise this OID make up the initial set of components for the provided OID.- Parameters:
oid
- The OID for which to make the determination. It must not benull
, and it must represent a valid numeric OID.- Returns:
true
if this OID is an ancestor of the provided OID, orfalse
if not.- Throws:
java.text.ParseException
- If either this OID or the provided OID does not represent a valid numeric OID.
-
isDescendantOf
public boolean isDescendantOf(@NotNull OID oid) throws java.text.ParseException
Indicates whether this OID is a descendant of the provided OID. This OID will be considered a descendant of the provided OID if this OID has more components than the provided OID, and if the components that comprise the provided OID make up the initial set of components for this OID.- Parameters:
oid
- The OID for which to make the determination. It must not benull
, and it must represent a valid numeric OID.- Returns:
true
if this OID is a descendant of the provided OID, orfalse
if not.- Throws:
java.text.ParseException
- If either this OID or the provided OID does not represent a valid numeric OID.
-
hashCode
public int hashCode()
Retrieves a hash code for this OID.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- A hash code for this OID.
-
equals
public boolean equals(@Nullable java.lang.Object o)
Indicates whether the provided object is equal to this OID.- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- The object for which to make the determination.- Returns:
true
if the provided object is equal to this OID, orfalse
if not.
-
compareTo
public int compareTo(@NotNull OID oid)
Indicates the position of the provided object relative to this OID in a sorted list.- Specified by:
compareTo
in interfacejava.lang.Comparable<OID>
- Parameters:
oid
- The OID to compare against this OID.- Returns:
- A negative value if this OID should come before the provided OID in a sorted list, a positive value if this OID should come after the provided OID in a sorted list, or zero if the two OIDs represent equivalent values.
-
-