Package org.apache.juneau.html

Enum Class AsideFloat

java.lang.Object

java.lang.Enum<AsideFloat>

org.apache.juneau.html.AsideFloat

All Implemented Interfaces:

Serializable, Comparable<AsideFloat>, Constable

public enum AsideFloat
extends Enum<AsideFloat>

Identifies possible float values for HtmlDocSerializer.Builder.asideFloat(AsideFloat).

See Also:

• HTML Basics

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	Float below main contents.
DEFAULT	Default value (defaults to LEFT
LEFT	Float right of main contents.
RIGHT	Float left of main contents.
TOP	Float above main contents.

Method Summary

Modifier and Type	Method	Description
boolean	is(AsideFloat value)	Returns true if value matches this enum.
boolean	isAny(AsideFloat... values)	Returns true if any of the values match this enum.
static AsideFloat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AsideFloat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT

public static final AsideFloat LEFT

Float right of main contents.

RIGHT

public static final AsideFloat RIGHT

Float left of main contents.

TOP

public static final AsideFloat TOP

Float above main contents.

BOTTOM

public static final AsideFloat BOTTOM

Float below main contents.

DEFAULT

public static final AsideFloat DEFAULT

Default value (defaults to LEFT

Method Details

values

public static AsideFloat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AsideFloat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

is

public boolean is(AsideFloat value)

Returns true if value matches this enum.

Parameters:

value - The value to check against.

Returns:

true if value matches this enum.

isAny

public boolean isAny(AsideFloat... values)

Returns true if any of the values match this enum.

Parameters:

values - The values to check against.

Returns:

true if value matches this enum.