Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MSHARED-985] XmlWriterUtil platform independent and consistent #91

Merged
merged 2 commits into from
May 3, 2021
Merged

[MSHARED-985] XmlWriterUtil platform independent and consistent #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e36497
make XmlWriterUtil platform independent and consistent with its docum…
elharo May 2, 2021
d210fa7
grammar
elharo May 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 23 additions & 20 deletions src/main/java/org/apache/maven/shared/utils/xml/XmlWriterUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ public class XmlWriterUtil
{
/** The vm line separator */
public static final String LS = System.getProperty( "line.separator" );

/** Platform independent line separator */
private static final String CRLF = "\r\n";

/** The default line indenter size i.e. 2. */
public static final int DEFAULT_INDENTATION_SIZE = 2;
Expand All @@ -43,7 +46,7 @@ public class XmlWriterUtil
* Convenience method to write one <code>CRLF</code>.
*
* @param writer not null writer
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeLineBreak( XMLWriter writer ) throws IOException
{
Expand All @@ -55,13 +58,13 @@ public static void writeLineBreak( XMLWriter writer ) throws IOException
*
* @param writer not null
* @param repeat positive number
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeLineBreak( XMLWriter writer, int repeat ) throws IOException
{
for ( int i = 0; i < repeat; i++ )
{
writer.writeMarkup( LS );
writer.writeMarkup( CRLF );
}
}

Expand All @@ -73,7 +76,7 @@ public static void writeLineBreak( XMLWriter writer, int repeat ) throws IOExcep
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeLineBreak(XMLWriter, int, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeLineBreak( XMLWriter writer, int repeat, int indent ) throws IOException
{
Expand All @@ -87,7 +90,7 @@ public static void writeLineBreak( XMLWriter writer, int repeat, int indent ) th
* @param repeat The number of repetitions of the indent
* @param indent positive number
* @param indentSize positive number
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeLineBreak( XMLWriter writer, int repeat, int indent, int indentSize ) throws IOException
{
Expand All @@ -112,7 +115,7 @@ public static void writeLineBreak( XMLWriter writer, int repeat, int indent, int
* @param writer not null
* @see #DEFAULT_COLUMN_LINE
* @see #writeCommentLineBreak(XMLWriter, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentLineBreak( XMLWriter writer ) throws IOException
{
Expand All @@ -124,7 +127,7 @@ public static void writeCommentLineBreak( XMLWriter writer ) throws IOException
*
* @param writer not null
* @param columnSize positive number
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentLineBreak( XMLWriter writer, int columnSize ) throws IOException
{
Expand All @@ -133,18 +136,18 @@ public static void writeCommentLineBreak( XMLWriter writer, int columnSize ) thr
columnSize = DEFAULT_COLUMN_LINE;
}

writer.writeMarkup( "<!-- " + StringUtils.repeat( "=", columnSize - 10 ) + " -->" + LS );
writer.writeMarkup( "<!-- " + StringUtils.repeat( "=", columnSize - 10 ) + " -->" + CRLF );
}

/**
* Convenience method to write XML comment line. The <code>comment</code> is splitted to have a size of
* Convenience method to write XML comment line. The <code>comment</code> is split to have a size of
* <code>80</code>.
*
* @param writer not null
* @param comment The comment to write
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeComment(XMLWriter, String, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeComment( XMLWriter writer, String comment ) throws IOException
{
Expand All @@ -160,7 +163,7 @@ public static void writeComment( XMLWriter writer, String comment ) throws IOExc
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeComment(XMLWriter, String, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeComment( XMLWriter writer, String comment, int indent ) throws IOException
{
Expand All @@ -177,7 +180,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent )
* @param indentSize positive number
* @see #DEFAULT_COLUMN_LINE
* @see #writeComment(XMLWriter, String, int, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeComment( XMLWriter writer, String comment, int indent, int indentSize ) throws IOException
{
Expand All @@ -193,7 +196,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent, i
* @param indent positive number
* @param indentSize positive number
* @param columnSize positive number
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeComment( XMLWriter writer, String comment, int indent, int indentSize, int columnSize )
throws IOException
Expand All @@ -220,7 +223,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent, i

String indentation = StringUtils.repeat( " ", indent * indentSize );
int magicNumber = indentation.length() + columnSize - "-->".length() - 1;
String[] sentences = StringUtils.split( comment, LS );
String[] sentences = StringUtils.split( comment, CRLF );

StringBuffer line = new StringBuffer( indentation + "<!-- " );
for ( String sentence : sentences )
Expand All @@ -239,7 +242,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent, i
line.append( StringUtils.repeat( " ", magicNumber - line.length() ) );
}

line.append( "-->" ).append( LS );
line.append( "-->" ).append( CRLF );
writer.writeMarkup( line.toString() );
}
line = new StringBuffer( indentation + "<!-- " );
Expand All @@ -262,7 +265,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent, i
line.append( StringUtils.repeat( " ", magicNumber - line.length() ) );
}

line.append( "-->" ).append( LS );
line.append( "-->" ).append( CRLF );

writer.writeMarkup( line.toString() );
}
Expand All @@ -275,7 +278,7 @@ public static void writeComment( XMLWriter writer, String comment, int indent, i
* @param comment The comment to write
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeCommentText(XMLWriter, String, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentText( XMLWriter writer, String comment ) throws IOException
{
Expand All @@ -292,7 +295,7 @@ public static void writeCommentText( XMLWriter writer, String comment ) throws I
* @param indent positive number
* @see #DEFAULT_INDENTATION_SIZE
* @see #writeCommentText(XMLWriter, String, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentText( XMLWriter writer, String comment, int indent ) throws IOException
{
Expand All @@ -309,7 +312,7 @@ public static void writeCommentText( XMLWriter writer, String comment, int inden
* @param indentSize positive number
* @see #DEFAULT_COLUMN_LINE
* @see #writeCommentText(XMLWriter, String, int, int, int)
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentText( XMLWriter writer, String comment, int indent, int indentSize )
throws IOException
Expand All @@ -327,7 +330,7 @@ public static void writeCommentText( XMLWriter writer, String comment, int inden
* @param indent positive number
* @param indentSize positive number
* @param columnSize positive number
* @throws IOException if writing fails.
* @throws IOException if writing fails
*/
public static void writeCommentText( XMLWriter writer, String comment, int indent, int indentSize, int columnSize )
throws IOException
Expand Down