org.codehaus.plexus.util.xml.XmlWriterUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plexus-xml Show documentation
Show all versions of plexus-xml Show documentation
A collection of various utility classes to ease working with XML.
The newest version!
package org.codehaus.plexus.util.xml;
/*
* Copyright The Codehaus Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Utility class for the XmlWriter class.
*
* @author Vincent Siveton
*
*/
public class XmlWriterUtil {
/** The vm line separator */
public static final String LS = System.getProperty("line.separator");
/** The default line indenter size i.e. 2. */
public static final int DEFAULT_INDENTATION_SIZE = 2;
/** The default column before line wrapping i.e. 80. */
public static final int DEFAULT_COLUMN_LINE = 80;
/**
* Convenience method to write one CRLF.
*
* @param writer not null writer
*/
public static void writeLineBreak(XMLWriter writer) {
writeLineBreak(writer, 1);
}
/**
* Convenience method to repeat CRLF.
*
* @param writer not null
* @param repeat positive number
*/
public static void writeLineBreak(XMLWriter writer, int repeat) {
for (int i = 0; i < repeat; i++) {
writer.writeMarkup(LS);
}
}
/**
* Convenience method to repeat CRLF and to indent the writer by 2.
*
* @param writer not null
* @param repeat space repeat
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeLineBreak(XMLWriter, int, int, int)
*/
public static void writeLineBreak(XMLWriter writer, int repeat, int indent) {
writeLineBreak(writer, repeat, indent, DEFAULT_INDENTATION_SIZE);
}
/**
* Convenience method to repeat CRLF and to indent the writer by indentSize.
*
* @param writer not null
* @param repeat repeat time
* @param indent positive number
* @param indentSize positive number
*/
public static void writeLineBreak(XMLWriter writer, int repeat, int indent, int indentSize) {
writeLineBreak(writer, repeat);
if (indent < 0) {
indent = 0;
}
if (indentSize < 0) {
indentSize = 0;
}
writer.writeText(StringUtils.repeat(" ", indent * indentSize));
}
/**
* Convenience method to write XML comment line break. Its size is 80.
*
* @param writer not null
* @see #DEFAULT_COLUMN_LINE
* @see #writeCommentLineBreak(XMLWriter, int)
*/
public static void writeCommentLineBreak(XMLWriter writer) {
writeCommentLineBreak(writer, DEFAULT_COLUMN_LINE);
}
/**
* Convenience method to write XML comment line break with columnSize as length.
*
* @param writer not null
* @param columnSize positive number
*/
public static void writeCommentLineBreak(XMLWriter writer, int columnSize) {
if (columnSize < 10) {
columnSize = DEFAULT_COLUMN_LINE;
}
writer.writeMarkup("" + LS);
}
/**
* Convenience method to write XML comment line. The comment is splitted to have a size of
* 80.
*
* @param writer not null
* @param comment the comment
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeComment(XMLWriter, String, int, int)
*/
public static void writeComment(XMLWriter writer, String comment) {
writeComment(writer, comment, 0, DEFAULT_INDENTATION_SIZE);
}
/**
* 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.
*
* @param writer not null
* @param comment the comment
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeComment(XMLWriter, String, int, int)
*/
public static void writeComment(XMLWriter writer, String comment, int indent) {
writeComment(writer, comment, indent, DEFAULT_INDENTATION_SIZE);
}
/**
* Convenience method to write XML comment line. The comment is splitted to have a size of
* 80 and is indented by indent using indentSize.
*
* @param writer not null
* @param comment the comment
* @param indent positive number
* @param indentSize positive number
* @see #DEFAULT_COLUMN_LINE
* @see #writeComment(XMLWriter, String, int, int, int)
*/
public static void writeComment(XMLWriter writer, String comment, int indent, int indentSize) {
writeComment(writer, comment, indent, indentSize, DEFAULT_COLUMN_LINE);
}
/**
* Convenience method to write XML comment line. The comment is splitted to have a size of
* columnSize and is indented by indent using indentSize.
*
* @param writer not null
* @param comment the comment
* @param indent positive number
* @param indentSize positive number
* @param columnSize positive number
*/
public static void writeComment(XMLWriter writer, String comment, int indent, int indentSize, int columnSize) {
if (comment == null) {
comment = "null";
}
while (comment.contains("")) {
comment = comment.replace("-->", "");
}
if (indent < 0) {
indent = 0;
}
if (indentSize < 0) {
indentSize = 0;
}
if (columnSize < 0) {
columnSize = DEFAULT_COLUMN_LINE;
}
String indentation = StringUtils.repeat(" ", indent * indentSize);
int magicNumber = indentation.length() + columnSize - "-->".length() - 1;
String[] sentences = StringUtils.split(comment, LS);
StringBuffer line = new StringBuffer(indentation + "").append(LS);
writer.writeMarkup(line.toString());
}
line = new StringBuffer(indentation + "").append(LS);
writer.writeMarkup(line.toString());
}
/**
* Convenience method to write XML comments between two comments line break. The XML comment block is not indented.
*
* @param writer not null
* @param comment the comment
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeCommentText(XMLWriter, String, int, int)
*/
public static void writeCommentText(XMLWriter writer, String comment) {
writeCommentText(writer, comment, 0, DEFAULT_INDENTATION_SIZE);
}
/**
* 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.
*
* @param writer not null
* @param comment the comment
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeCommentText(XMLWriter, String, int, int)
*/
public static void writeCommentText(XMLWriter writer, String comment, int indent) {
writeCommentText(writer, comment, indent, DEFAULT_INDENTATION_SIZE);
}
/**
* Convenience method to write XML comment between two comment line break. The XML comment block is also indented by
* indent using indentSize.
*
* @param writer not null
* @param comment the comment
* @param indent positive number
* @param indentSize positive number
* @see #DEFAULT_COLUMN_LINE
* @see #writeCommentText(XMLWriter, String, int, int, int)
*/
public static void writeCommentText(XMLWriter writer, String comment, int indent, int indentSize) {
writeCommentText(writer, comment, indent, indentSize, DEFAULT_COLUMN_LINE);
}
/**
* 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.
*
* @param writer not null
* @param comment comment
* @param indent positive number
* @param indentSize positive number
* @param columnSize positive number
*/
public static void writeCommentText(XMLWriter writer, String comment, int indent, int indentSize, int columnSize) {
if (indent < 0) {
indent = 0;
}
if (indentSize < 0) {
indentSize = 0;
}
if (columnSize < 0) {
columnSize = DEFAULT_COLUMN_LINE;
}
writeLineBreak(writer, 1);
writer.writeMarkup(StringUtils.repeat(" ", indent * indentSize));
writeCommentLineBreak(writer, columnSize);
writeComment(writer, comment, indent, indentSize, columnSize);
writer.writeMarkup(StringUtils.repeat(" ", indent * indentSize));
writeCommentLineBreak(writer, columnSize);
writeLineBreak(writer, 1, indent, indentSize);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy