netscape.ldap.util
Class DSMLWriter

java.lang.Object
  |
  +--netscape.ldap.util.LDAPWriter
        |
        +--netscape.ldap.util.DSMLWriter

All Implemented Interfaces:

java.io.Serializable

public class DSMLWriter

extends LDAPWriter

Class for outputting LDAP entries to a stream as DSML.

See Also:

Serialized Form

Field Summary

Fields inherited from class netscape.ldap.util.LDAPWriter

m_pw

Constructor Summary

DSMLWriter(java.io.PrintWriter pw)
Constructs a DSMLWriter object to output entries to a stream as DSML.

Method Summary

protected void	printAttribute(LDAPAttribute attr) Print an attribute of an entry
protected void	printAttributeSchema(LDAPSchema schema) Prints the attribute schema from a schema object schema schema elements
void	printEntries(java.util.Vector entries) Print a vector of entries, with wrapper tags
protected void	printEntryEnd(java.lang.String dn) Print epilogue to entry
protected void	printEntryStart(java.lang.String dn) Print prologue to entry
protected void	printEscapedValue(java.lang.String prolog, java.lang.String value, java.lang.String epilog) Print the element start, the value with escaping of special characters, and the element end
void	printFooter() Print epilogue to section of DSML
void	printHeader() Print prolog to section of DSML
protected void	printObjectClassSchema(LDAPSchema schema) Prints the object class schema from a schema object schema schema elements
void	printSchema(LDAPEntry entry) Prints the schema from an entry containing subschema entry entry containing schema definitions
void	printSchema(LDAPSchema schema) Prints a given schema
protected void	printString(java.lang.String value)

Methods inherited from class netscape.ldap.util.LDAPWriter

getPrintableValue, printEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

DSMLWriter

public DSMLWriter(java.io.PrintWriter pw)

Constructs a DSMLWriter object to output entries to a stream as DSML.

Parameters:

pw - output stream

Method Detail

printSchema

public void printSchema(LDAPEntry entry)

Prints the schema from an entry containing subschema entry entry containing schema definitions

Overrides:

printSchema in class LDAPWriter

Parameters:

entry - an LDAPEntry containing schema to be formatted to the output stream

printSchema

public void printSchema(LDAPSchema schema)

Prints a given schema

Parameters:

schema - LDAPSchema object to print

printObjectClassSchema

protected void printObjectClassSchema(LDAPSchema schema)

Prints the object class schema from a schema object schema schema elements

printAttributeSchema

protected void printAttributeSchema(LDAPSchema schema)

Prints the attribute schema from a schema object schema schema elements

printAttribute

protected void printAttribute(LDAPAttribute attr)

Print an attribute of an entry

Specified by:

printAttribute in class LDAPWriter

Parameters:

attr - the attribute to format to the output stream

printEntryStart

protected void printEntryStart(java.lang.String dn)

Print prologue to entry

Specified by:

printEntryStart in class LDAPWriter

Parameters:

dn - the DN of the entry

printEntryEnd

protected void printEntryEnd(java.lang.String dn)

Print epilogue to entry

Specified by:

printEntryEnd in class LDAPWriter

Parameters:

dn - the DN of the entry

printEntries

public void printEntries(java.util.Vector entries)

Print a vector of entries, with wrapper tags

Parameters:

entries - A vector of LDAPEntry

printHeader

public void printHeader()

Print prolog to section of DSML

Overrides:

printHeader in class LDAPWriter

printFooter

public void printFooter()

Print epilogue to section of DSML

Overrides:

printFooter in class LDAPWriter

printEscapedValue

protected void printEscapedValue(java.lang.String prolog,
                                 java.lang.String value,
                                 java.lang.String epilog)

Print the element start, the value with escaping of special characters, and the element end

Parameters:

prolog - element start

value - value to be escaped

epilog - element end

printString

protected void printString(java.lang.String value)