com.oziexplorer
Enum TrackFill

java.lang.Object
  java.lang.Enum<TrackFill>
      com.oziexplorer.TrackFill

All Implemented Interfaces:

Serializable, Comparable<TrackFill>

public enum TrackFill
extends Enum<TrackFill>

Enumeration of the different track fills supported by OziExplorer.

Copyright 2011 Alan Burlison, . All rights reserved. Use is subject to license terms, see LICENSE.txt.

Enum Constant Summary

CLEAR
No fill.

CROSS
Cross-hatch.

DIAG_CROSS
Diagonal cross-hatch.

DIAGONAL1
Diagonal fill 1.

DIAGONAL2
Diagonal fill 2.

HORIZONTAL
Horizontal lines.

SOLID
Solid fill.

VERTICAL
vertical lines.

Method Summary

int	getInteger() Retrieve the integer constant for this emumerated type member.
String	getString() Retrieve the name of this enumerated type member.
static TrackFill	intToEnum(int value) Convert the integers used by OziAPI to identify track fill types to the enumeration type.
String	toString() Retrieve a string representation of this enumerated type member.
static TrackFill	valueOf(String name) Returns the enum constant of this type with the specified name.
static TrackFill[]	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

SOLID

public static final TrackFill SOLID

Solid fill.

CLEAR

public static final TrackFill CLEAR

No fill.

DIAGONAL1

public static final TrackFill DIAGONAL1

Diagonal fill 1.

DIAGONAL2

public static final TrackFill DIAGONAL2

Diagonal fill 2.

CROSS

public static final TrackFill CROSS

Cross-hatch.

DIAG_CROSS

public static final TrackFill DIAG_CROSS

Diagonal cross-hatch.

HORIZONTAL

public static final TrackFill HORIZONTAL

Horizontal lines.

VERTICAL

public static final TrackFill VERTICAL

vertical lines.

Method Detail

values

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

Returns:

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

valueOf

public static TrackFill valueOf(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:

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

NullPointerException - if the argument is null

getInteger

public int getInteger()

Retrieve the integer constant for this emumerated type member.

Returns:

the integer constant for this enumerated type member.

getString

public String getString()

Retrieve the name of this enumerated type member.

Returns:

the name of this enumerated type member.

toString

public String toString()

Retrieve a string representation of this enumerated type member.

Overrides:

toString in class Enum<TrackFill>

Returns:

a string representation of this enumerated type member.

intToEnum

public static TrackFill intToEnum(int value)
                           throws OziException

Convert the integers used by OziAPI to identify track fill types to the enumeration type.

Parameters:

value - integer representation of the track fill type.

Returns:

the enumeration corresponding to the value.

Throws:

OziException - if the track fill type is unrecognised.