com.palantir.javaformat

Enum CloseOp

java.lang.Object

java.lang.Enum<CloseOp>

com.palantir.javaformat.CloseOp

All Implemented Interfaces:

Op, java.io.Serializable, java.lang.Comparable<CloseOp>

public enum CloseOp
extends java.lang.Enum<CloseOp>
implements Op

A CloseOp closes a level. It is an Op in the sequence of Ops generated by OpsBuilder. When the sequence is turned into a Doc by DocBuilder, ranges delimited by OpenOp-CloseOp pairs turn into nested Doc.Levels.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE

Method Summary

Modifier and Type	Method and Description
void	add(DocBuilder builder) Add an Op to a DocBuilder.
static Op	make() Make a CloseOp, returning a singleton since they are all the same.
java.lang.String	toString()
static CloseOp	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CloseOp[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLOSE

public static final CloseOp CLOSE

Method Detail

values

public static CloseOp[] 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 (CloseOp c : CloseOp.values())
    System.out.println(c);

Returns:

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

valueOf

public static CloseOp 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

make

public static Op make()

Make a CloseOp, returning a singleton since they are all the same.

Returns:

the singleton CloseOp

add

public void add(DocBuilder builder)

Description copied from interface: Op

Add an Op to a DocBuilder.

Specified by:

add in interface Op

Parameters:

builder - the DocBuilder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CloseOp>