net.sf.mpxj.mpp
Enum GanttBarDateFormat

java.lang.Object
  extended by java.lang.Enum<GanttBarDateFormat>
      extended by net.sf.mpxj.mpp.GanttBarDateFormat
All Implemented Interfaces:
Serializable, Comparable<GanttBarDateFormat>, MpxjEnum

public enum GanttBarDateFormat
extends Enum<GanttBarDateFormat>
implements MpxjEnum

Enumeration representing the formats which may be shown on a Gantt chart timescale.


Enum Constant Summary
DD
           
DD_MMM
           
DD_MMM_HHMM
           
DD_MMM_YY
           
DD_MMMM
           
DD_MMMM_YYYY
           
DD_MMMM_YYYY_HHMM
           
DDD_DD
           
DDD_DD_MMM
           
DDD_DD_MMM_YY
           
DDD_DDMM
           
DDD_DDMMYY
           
DDD_DDMMYY_HHMM
           
DDD_HHMM
           
DDMM
           
DDMMYY
           
DDMMYY_MMSS
           
DDMMYYYY
           
DEFAULT
           
HHMM
           
MWW
           
MWWYY_HHMM
           
 
Method Summary
static GanttBarDateFormat getInstance(int type)
          Retrieve an instance of the enum based on its int value.
static GanttBarDateFormat getInstance(Number type)
          Retrieve an instance of the enum based on its int value.
 String getName()
          Retrieve the name of this alignment.
 int getValue()
          Accessor method used to retrieve the numeric representation of the enum.
 String toString()
          Generate a string representation of this instance.
static GanttBarDateFormat valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GanttBarDateFormat[] 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

DEFAULT

public static final GanttBarDateFormat DEFAULT

DDMMYY_MMSS

public static final GanttBarDateFormat DDMMYY_MMSS

DDMMYY

public static final GanttBarDateFormat DDMMYY

DDMMYYYY

public static final GanttBarDateFormat DDMMYYYY

DD_MMMM_YYYY_HHMM

public static final GanttBarDateFormat DD_MMMM_YYYY_HHMM

DD_MMMM_YYYY

public static final GanttBarDateFormat DD_MMMM_YYYY

DD_MMM_HHMM

public static final GanttBarDateFormat DD_MMM_HHMM

DD_MMM_YY

public static final GanttBarDateFormat DD_MMM_YY

DD_MMMM

public static final GanttBarDateFormat DD_MMMM

DD_MMM

public static final GanttBarDateFormat DD_MMM

DDD_DDMMYY_HHMM

public static final GanttBarDateFormat DDD_DDMMYY_HHMM

DDD_DDMMYY

public static final GanttBarDateFormat DDD_DDMMYY

DDD_DD_MMM_YY

public static final GanttBarDateFormat DDD_DD_MMM_YY

DDD_HHMM

public static final GanttBarDateFormat DDD_HHMM

DDD_DD_MMM

public static final GanttBarDateFormat DDD_DD_MMM

DDD_DDMM

public static final GanttBarDateFormat DDD_DDMM

DDD_DD

public static final GanttBarDateFormat DDD_DD

DDMM

public static final GanttBarDateFormat DDMM

DD

public static final GanttBarDateFormat DD

HHMM

public static final GanttBarDateFormat HHMM

MWW

public static final GanttBarDateFormat MWW

MWWYY_HHMM

public static final GanttBarDateFormat MWWYY_HHMM
Method Detail

values

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

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

valueOf

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

getInstance

public static GanttBarDateFormat getInstance(int type)
Retrieve an instance of the enum based on its int value.

Parameters:
type - int type
Returns:
enum instance

getInstance

public static GanttBarDateFormat getInstance(Number type)
Retrieve an instance of the enum based on its int value.

Parameters:
type - int type
Returns:
enum instance

getValue

public int getValue()
Accessor method used to retrieve the numeric representation of the enum.

Specified by:
getValue in interface MpxjEnum
Returns:
int representation of the enum

getName

public String getName()
Retrieve the name of this alignment. Note that this is not localised.

Returns:
name of this alignment type

toString

public String toString()
Generate a string representation of this instance.

Overrides:
toString in class Enum<GanttBarDateFormat>
Returns:
string representation of this instance


Copyright © 2012. All Rights Reserved.