org.codehaus.plexus.util.xml

Class XmlWriterUtil

public class XmlWriterUtil extends Object

Utility class for the XmlWriter class.

Version: $Id: XmlWriterUtil.java 8660 2010-03-05 21:50:36Z hboutemy $

Field Summary
static int	DEFAULT_COLUMN_LINE The default column before line wrapping i.e.
static int	DEFAULT_INDENTATION_SIZE The default line indenter size i.e.
static String	LS The vm line separator

Method Summary
static void	writeComment(XMLWriter writer, String comment) Convenience method to write XML comment line.
static void	writeComment(XMLWriter writer, String comment, int indent) Convenience method to write XML comment line.
static void	writeComment(XMLWriter writer, String comment, int indent, int indentSize) Convenience method to write XML comment line.
static void	writeComment(XMLWriter writer, String comment, int indent, int indentSize, int columnSize) Convenience method to write XML comment line.
static void	writeCommentLineBreak(XMLWriter writer) Convenience method to write XML comment line break.
static void	writeCommentLineBreak(XMLWriter writer, int columnSize) Convenience method to write XML comment line break with `columnSize` as length.
static void	writeCommentText(XMLWriter writer, String comment) Convenience method to write XML comments between two comments line break.
static void	writeCommentText(XMLWriter writer, String comment, int indent) Convenience method to write XML comments between two comments line break.
static void	writeCommentText(XMLWriter writer, String comment, int indent, int indentSize) Convenience method to write XML comment between two comment line break.
static void	writeCommentText(XMLWriter writer, String comment, int indent, int indentSize, int columnSize) Convenience method to write XML comments between two comments line break.
static void	writeLineBreak(XMLWriter writer) Convenience method to write one `CRLF`.
static void	writeLineBreak(XMLWriter writer, int repeat) Convenience method to repeat `CRLF`.
static void	writeLineBreak(XMLWriter writer, int repeat, int indent) Convenience method to repeat `CRLF` and to indent the writer by `2`.
static void	writeLineBreak(XMLWriter writer, int repeat, int indent, int indentSize) Convenience method to repeat `CRLF` and to indent the writer by `indentSize`.

Field Detail

DEFAULT_COLUMN_LINE

public static final int DEFAULT_COLUMN_LINE

The default column before line wrapping i.e. 80.

DEFAULT_INDENTATION_SIZE

public static final int DEFAULT_INDENTATION_SIZE

The default line indenter size i.e. 2.

LS

public static final String LS

The vm line separator

Method Detail

writeComment

public static void writeComment(XMLWriter writer, String comment)

Convenience method to write XML comment line. The comment is splitted to have a size of 80.

Parameters: writer not null comment

writeComment

public static void writeComment(XMLWriter writer, String comment, int indent)

Convenience method to write XML comment line. The comment is splitted to have a size of 80 and is indented by indent using 2 as indentation size.

Parameters: writer not null comment indent positive number

writeComment

public static void writeComment(XMLWriter writer, String comment, int indent, int indentSize)

Convenience method to write XML comment line. The comment is splitted to have a size of 80 and is indented by indent using indentSize.

Parameters: writer not null comment indent positive number indentSize positive number

writeComment

public static void writeComment(XMLWriter writer, String comment, int indent, int indentSize, int columnSize)

Convenience method to write XML comment line. The comment is splitted to have a size of columnSize and is indented by indent using indentSize.

Parameters: writer not null comment indent positive number indentSize positive number columnSize positive number

writeCommentLineBreak

public static void writeCommentLineBreak(XMLWriter writer)

Convenience method to write XML comment line break. Its size is 80.

Parameters: writer not null

writeCommentLineBreak

public static void writeCommentLineBreak(XMLWriter writer, int columnSize)

Convenience method to write XML comment line break with columnSize as length.

Parameters: writer not null columnSize positive number

writeCommentText

public static void writeCommentText(XMLWriter writer, String comment)

Convenience method to write XML comments between two comments line break. The XML comment block is not indented.

Parameters: writer not null comment

writeCommentText

public static void writeCommentText(XMLWriter writer, String comment, int indent)

Convenience method to write XML comments between two comments line break. The XML comment block is also indented by indent using 2 as indentation size.

Parameters: writer not null comment indent positive number

writeCommentText

public static void writeCommentText(XMLWriter writer, String comment, int indent, int indentSize)

Convenience method to write XML comment between two comment line break. The XML comment block is also indented by indent using indentSize.

Parameters: writer not null comment indent positive number indentSize positive number

writeCommentText

public static void writeCommentText(XMLWriter writer, String comment, int indent, int indentSize, int columnSize)

Convenience method to write XML comments between two comments line break. The XML comment block is also indented by indent using indentSize. The column size could be also be specified.

Parameters: writer not null comment indent positive number indentSize positive number columnSize positive number

writeLineBreak

public static void writeLineBreak(XMLWriter writer)

Convenience method to write one CRLF.

Parameters: writer not null writer

writeLineBreak

public static void writeLineBreak(XMLWriter writer, int repeat)

Convenience method to repeat CRLF.

Parameters: writer not null repeat positive number

writeLineBreak

public static void writeLineBreak(XMLWriter writer, int repeat, int indent)

Convenience method to repeat CRLF and to indent the writer by 2.

Parameters: writer not null repeat indent positive number

writeLineBreak

public static void writeLineBreak(XMLWriter writer, int repeat, int indent, int indentSize)

Convenience method to repeat CRLF and to indent the writer by indentSize.

Parameters: writer not null repeat indent positive number indentSize positive number