net.markenwerk.utils.text.indentation.LineBreak Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utils-text-indentation Show documentation

A Common indentation for pretty printing libraries for Java

There is a newer version: 1.1.2

Show newest version

package net.markenwerk.utils.text.indentation;

/**
 * An {@link Whitespace} is a line break character string.
 * 
 * @author Torsten Krause (tk at markenwerk dot net)
 * @since 1.0.0
 */
public enum LineBreak {

	/** The empty string */
	NONE(""), 
	
	/**
	 * A single line feed character.
	 */
	UNIX("\n"),

	/**
	 * A carriage return character followed by an line feed character.
	 */
	WINDOWS("\r\n"),

	/**
	 * The content of the system {@link System#getProperty(String) property}
	 * {@code line.separator}.
	 */
	SYSTEM(System.getProperty("line.separator"));
	
	

	private final String lineBreakString;

	private LineBreak(String lineBreakString) {
		this.lineBreakString = lineBreakString;
	}

	/**
	 * Returns the line break string of this {@link LineBreak};
	 * 
	 * @return The line break string of this {@link LineBreak};
	 */
	public String getLineBreakString() {
		return lineBreakString;
	}

}