org.apache.jackrabbit.commons.cnd

Class CompactNodeTypeDefWriter

java.lang.Object

org.apache.jackrabbit.commons.cnd.CompactNodeTypeDefWriter

Direct Known Subclasses:

CompactNodeTypeDefWriter

public class CompactNodeTypeDefWriter
extends Object

Prints node type defs in a compact notation Print Format: <ex = "http://apache.org/jackrabbit/example"> [ex:NodeType] > ex:ParentType1, ex:ParentType2 orderable mixin - ex:property (STRING) = 'default1', 'default2' primary mandatory autocreated protected multiple VERSION < 'constraint1', 'constraint2' + ex:node (ex:reqType1, ex:reqType2) = ex:defaultType mandatory autocreated protected multiple VERSION

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CompactNodeTypeDefWriter.NamespaceMapping Map namespace prefixes such as present in a qualified JCR name to the corresponding namespace URI.

Constructor Summary

Constructors

Constructor and Description
CompactNodeTypeDefWriter(Writer out, CompactNodeTypeDefWriter.NamespaceMapping nsMapping, boolean includeNS) Creates a new nodetype writer based on a session
CompactNodeTypeDefWriter(Writer out, Session session, boolean includeNS) Creates a new nodetype writer based on a session

Method Summary

Modifier and Type	Method and Description
void	close() Flushes all pending write operations and Closes this writer.
static void	write(Collection<NodeTypeDefinition> defs, CompactNodeTypeDefWriter.NamespaceMapping nsMapping, Writer out) Writes the given list of QNodeTypeDefinition to the output writer including the used namespaces.
static void	write(Collection<NodeTypeDefinition> defs, Session session, Writer out) Writes the given list of QNodeTypeDefinition to the output writer including the used namespaces.
void	write(NodeTypeDefinition ntd) Write one NodeTypeDefinition to this writer
void	writeNamespaceDeclaration(String prefix) Write a namespace declaration to this writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompactNodeTypeDefWriter

public CompactNodeTypeDefWriter(Writer out,
                                Session session,
                                boolean includeNS)

Creates a new nodetype writer based on a session

Parameters:

out - the underlying writer

session - repository session

includeNS - if true all used namespace decl. are also written to the writer

CompactNodeTypeDefWriter

public CompactNodeTypeDefWriter(Writer out,
                                CompactNodeTypeDefWriter.NamespaceMapping nsMapping,
                                boolean includeNS)

Creates a new nodetype writer based on a session

Parameters:

out - the underlying writer

nsMapping - the mapping from prefix to namespace URI.

includeNS - if true all used namespace decl. are also written to the writer

Method Detail

write

public static void write(Collection<NodeTypeDefinition> defs,
                         Session session,
                         Writer out)
                  throws IOException

Writes the given list of QNodeTypeDefinition to the output writer including the used namespaces.

Parameters:

defs - collection of definitions

session - session

out - output writer

Throws:

IOException - if an I/O error occurs

write

public static void write(Collection<NodeTypeDefinition> defs,
                         CompactNodeTypeDefWriter.NamespaceMapping nsMapping,
                         Writer out)
                  throws IOException

Writes the given list of QNodeTypeDefinition to the output writer including the used namespaces.

Parameters:

defs - collection of definitions

nsMapping - the mapping from prefix to namespace URI.

out - output writer

Throws:

IOException - if an I/O error occurs

write

public void write(NodeTypeDefinition ntd)
           throws IOException

Write one NodeTypeDefinition to this writer

Parameters:

ntd - node type definition

Throws:

IOException - if an I/O error occurs

writeNamespaceDeclaration

public void writeNamespaceDeclaration(String prefix)
                               throws IOException

Write a namespace declaration to this writer. Note, that this method has no effect if there is no extra namespace write present.

Parameters:

prefix - namespace prefix

Throws:

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Flushes all pending write operations and Closes this writer. please note, that the underlying writer remains open.

Throws:

IOException - if an I/O error occurs