jmlparser-core/com.github.javaparser.utils/LineSeparator

LineSeparator

A representation of line endings, that can be used throughout the codebase. This is to replace Utils.EOL which is not explicit in representing the system's EOL character. It also exposes helper methods for, e.g., detection of the line ending of a given string.

Author

Roger Howell

Entries

The CR \r line ending is the default line separator for classic MacOS

The LF \n line ending is the default line separator for Unix and modern MacOS

CRLF

The CRLF \r\n line ending is the default line separator for Windows

SYSTEM

This line ending is set to whatever the host system's line separator is

ARBITRARY

The ARBITRARY line ending can be used where we do not care about the line separator, only that we use the same one consistently

MIXED

The MIXED line ending is used where strings appear to have multiple different line separators e.g. "line 1\nline 2\rline 3\r\n" or "line 1\nline 2\rline 3\nline 4\n"

UNKNOWN

The UNKNOWN line ending can be used in the case where the given string has not yet been analysed to determine its line separator

NONE

The NONE line ending is used where there are precisely zero line endings e.g. a simple one-line string

Functions

asEscapedString

open fun asEscapedString(): String

asRawString

open fun asRawString(): String

describe

open fun describe(): String

detect

open fun detect(string: String): LineSeparator

equalsString

open fun equalsString(lineSeparator: LineSeparator): Boolean

getLineEnding

open fun getLineEnding(countCr: Int, countLf: Int, countCrLf: Int): LineSeparator

isStandardEol

open fun isStandardEol(): Boolean

lookup

open fun lookup(ending: String): Optional<LineSeparator>

lookupEscaped

open fun lookupEscaped(ending: String): Optional<LineSeparator>

toString

open fun toString(): String

valueOf

open fun valueOf(name: String): LineSeparator

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

open fun values(): Array<LineSeparator>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

LineSeparator

Author

See also

Entries

Functions