|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.transformations.ReplaceAttributeTransformation
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReplaceAttributeTransformation
This class provides an implementation of an entry transformation that can be used to replace existing attributes in entries with a default set of values. The default attributes will not be added to entries that do not have existing values for the target attributes.
Constructor Summary | |
---|---|
ReplaceAttributeTransformation(Schema schema,
Attribute... attributes)
Creates a new replace attribute transformation that will replace existing copies of the specified attributes with the provided versions. |
|
ReplaceAttributeTransformation(Schema schema,
java.util.Collection<Attribute> attributes)
Creates a new replace attribute transformation that will replace existing copies of the specified attributes with the provided versions. |
|
ReplaceAttributeTransformation(Schema schema,
java.lang.String attributeName,
java.util.Collection<java.lang.String> newValues)
Creates a new replace attribute transformation that will replace existing values of the specified attribute with the provided set of default values. |
|
ReplaceAttributeTransformation(Schema schema,
java.lang.String attributeName,
java.lang.String... newValues)
Creates a new replace attribute transformation that will replace existing values of the specified attribute with the provided set of default values. |
Method Summary | |
---|---|
Entry |
transformEntry(Entry e)
Applies an appropriate transformation to the provided entry. |
Entry |
translate(Entry original,
long firstLineNumber)
Applies some special transformation or filtering to the original Entry. |
Entry |
translateEntryToWrite(Entry original)
Applies some special transformation or filtering to the original Entry. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReplaceAttributeTransformation(Schema schema, java.lang.String attributeName, java.lang.String... newValues)
schema
- The schema to use to identify alternate names that
may be used to reference the attributes to replace.
It may be null
to use a default standard
schema.attributeName
- The name of the attribute for which to replace
existing values. It must not be null
.newValues
- The new values to use in place of the existing
values for the specified attribute.public ReplaceAttributeTransformation(Schema schema, java.lang.String attributeName, java.util.Collection<java.lang.String> newValues)
schema
- The schema to use to identify alternate names that
may be used to reference the attributes to replace.
It may be null
to use a default standard
schema.attributeName
- The name of the attribute for which to replace
existing values. It must not be null
.newValues
- The new values to use in place of the existing
values for the specified attribute.public ReplaceAttributeTransformation(Schema schema, Attribute... attributes)
schema
- The schema to use to identify alternate names that may
be used to reference the attributes to replace. It may
be null
to use a default standard schema.attributes
- The attributes to be used in place of existing
attributes of the same type. It must not be
null
or empty.public ReplaceAttributeTransformation(Schema schema, java.util.Collection<Attribute> attributes)
schema
- The schema to use to identify alternate names that may
be used to reference the attributes to replace. It may
be null
to use a default standard schema.attributes
- The attributes to be used in place of existing
attributes of the same type. It must not be
null
or empty.Method Detail |
---|
public Entry transformEntry(Entry e)
transformEntry
in interface EntryTransformation
e
- The entry to transform.
null
if the entry should be suppressed.public Entry translate(Entry original, long firstLineNumber)
translate
in interface LDIFReaderEntryTranslator
original
- The original Entry that was read and parsed from
the input file.firstLineNumber
- The first line number of the LDIF record
corresponding to the read Entry. This is most
useful when throwing an LDIFException.
LDIFReader.readEntry()
. This can be the original parameter
Entry, a newly constructed Entry, or null
to signal that
the provided Entry should be skipped.public Entry translateEntryToWrite(Entry original)
translateEntryToWrite
in interface LDIFWriterEntryTranslator
original
- The original Entry that was to be written.
null
to
signal that this Entry should not be written. Note, however, that
if the original entry provided as a parameter is altered, then
the change will be visible to anything that references that entry.
If you are not sure about whether changes to the original entry
are acceptable, it is recommended that you use the
duplicate()
method to create a copy of the original and
make the necessary changes to that duplicate.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |