com.google.api.tools.framework.snippet

Enum Doc.GroupKind

java.lang.Object

java.lang.Enum<Doc.GroupKind>

com.google.api.tools.framework.snippet.Doc.GroupKind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Doc.GroupKind>

Enclosing class:

Doc

public static enum Doc.GroupKind
extends java.lang.Enum<Doc.GroupKind>

Describes how the breaks within a group() should be printed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Each break is printed as a space, if that would not lead to overflow, or as a newline, otherwise.
FILL The breaks in the group are all printed as spaces, if the result would not overflow a single line, or as newlines, otherwise.
HORIZONTAL Breaks are printed as spaces.
VERTICAL Breaks are printed as newlines.

Method Summary

Modifier and Type	Method and Description
static Doc.GroupKind	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Doc.GroupKind[]	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

Enum Constant Detail

HORIZONTAL

public static final Doc.GroupKind HORIZONTAL

Breaks are printed as spaces.

VERTICAL

public static final Doc.GroupKind VERTICAL

Breaks are printed as newlines.

FILL

public static final Doc.GroupKind FILL

The breaks in the group are all printed as spaces, if the result would not overflow a single line, or as newlines, otherwise.

AUTO

public static final Doc.GroupKind AUTO

Each break is printed as a space, if that would not lead to overflow, or as a newline, otherwise. A different decision is made for each break.

Method Detail

values

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

Returns:

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

valueOf

public static Doc.GroupKind 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