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

/*
 * Copyright (c) 2016 Torsten Krause, Markenwerk GmbH
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
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;
	}

}