NewLine (PF-Text 8.3.0 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.pfsw.text
Enum NewLine

java.lang.Object
  java.lang.Enum<NewLine>
      org.pfsw.text.NewLine

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<NewLine>, org.pfsw.bif.enums.IEnumType, org.pfsw.bif.text.IStringRepresentation

public enum NewLine
extends java.lang.Enum<NewLine>
implements org.pfsw.bif.enums.IEnumType
extends java.lang.Enum<NewLine>
implements org.pfsw.bif.enums.IEnumType

Provides new line character sequences for the various operating systems.

Enum Constant Summary
`CURRENT_OS` The new line characters of the current operating system.
`LINUX` The Linux new line character LF ("\n").
`MAC` The Macintosh new line character CR ("\r").
`WINDOWS` The Windows new line characters CRLF ("\r\n").

Method Summary
`java.lang.String`	`asString()`
`static NewLine`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static NewLine[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.pfsw.bif.enums.IEnumType
`getDeclaringClass, name, ordinal`

Enum Constant Detail

LINUX

public static final NewLine LINUX

The Linux new line character LF ("\n").

MAC

public static final NewLine MAC

The Macintosh new line character CR ("\r").

WINDOWS

public static final NewLine WINDOWS

The Windows new line characters CRLF ("\r\n").

CURRENT_OS

public static final NewLine CURRENT_OS

The new line characters of the current operating system.

Method Detail

values

public static NewLine[] values()

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

for (NewLine c : NewLine.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static NewLine valueOf(java.lang.String name)

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.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null

asString

public java.lang.String asString()

Specified by:: asString in interface org.pfsw.bif.text.IStringRepresentation