Class LogField
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.logs.v2.LogField
-
- All Implemented Interfaces:
java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LogField extends java.lang.Object implements java.io.Serializable
This class defines a data structure that represents a field that may appear in a Directory Server log message.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LogField(java.lang.String fieldName, LogFieldSyntax<?> expectedSyntax)
Creates a log field with whe provided information.LogField(java.lang.String fieldName, java.lang.String constantName, LogFieldSyntax<?> expectedSyntax)
Creates a log field with whe provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getConstantName()
Retrieves the name of the constant in which this log field is defined.LogFieldSyntax<?>
getExpectedSyntax()
Retrieves the expected syntax for this field.java.lang.String
getFieldName()
Retrieves the name for this field.java.lang.String
toString()
Retrieves a string representation of this log field.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this log field to the provided buffer.
-
-
-
Constructor Detail
-
LogField
public LogField(@NotNull java.lang.String fieldName, @NotNull LogFieldSyntax<?> expectedSyntax)
Creates a log field with whe provided information.- Parameters:
fieldName
- The name for this field. It must not benull
.expectedSyntax
- The expected syntax for this field. It must not benull
.
-
LogField
public LogField(@NotNull java.lang.String fieldName, @Nullable java.lang.String constantName, @NotNull LogFieldSyntax<?> expectedSyntax)
Creates a log field with whe provided information.- Parameters:
fieldName
- The name for this field. It must not benull
.constantName
- The name of the constant in which this field is defined. This is primarily intended for internal use.expectedSyntax
- The expected syntax for this field. It must not benull
.
-
-
Method Detail
-
getFieldName
@NotNull public java.lang.String getFieldName()
Retrieves the name for this field.- Returns:
- The name for this field.
-
getConstantName
@Nullable @InternalUseOnly public java.lang.String getConstantName()
Retrieves the name of the constant in which this log field is defined.- Returns:
- The name of the constant in which this log field is defined, or
null
if it is not defined in any constant.
-
getExpectedSyntax
@NotNull public LogFieldSyntax<?> getExpectedSyntax()
Retrieves the expected syntax for this field. Note that this may be a generic instance of the associated syntax, which may or may not reflect the settings used to actually generate the log message.- Returns:
- The expected syntax for this field.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this log field.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this log field.
-
-