Package org.cakelab.jdoxml.api
Enum ICompound.CompoundKind
- java.lang.Object
-
- java.lang.Enum<ICompound.CompoundKind>
-
- org.cakelab.jdoxml.api.ICompound.CompoundKind
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ICompound.CompoundKind>
- Enclosing interface:
- ICompound
public static enum ICompound.CompoundKind extends java.lang.Enum<ICompound.CompoundKind>
Represents the kind of compounds recognised by doxygen.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
value()
static ICompound.CompoundKind
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ICompound.CompoundKind[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
Invalid
public static final ICompound.CompoundKind Invalid
-
Class
public static final ICompound.CompoundKind Class
-
Struct
public static final ICompound.CompoundKind Struct
-
Union
public static final ICompound.CompoundKind Union
-
Interface
public static final ICompound.CompoundKind Interface
-
Protocol
public static final ICompound.CompoundKind Protocol
-
Category
public static final ICompound.CompoundKind Category
-
Exception
public static final ICompound.CompoundKind Exception
-
File
public static final ICompound.CompoundKind File
-
Namespace
public static final ICompound.CompoundKind Namespace
-
Group
public static final ICompound.CompoundKind Group
-
Page
public static final ICompound.CompoundKind Page
-
Example
public static final ICompound.CompoundKind Example
-
Dir
public static final ICompound.CompoundKind Dir
-
-
Method Detail
-
values
public static ICompound.CompoundKind[] 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 (ICompound.CompoundKind c : ICompound.CompoundKind.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ICompound.CompoundKind 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 namejava.lang.NullPointerException
- if the argument is null
-
value
public int value()
-
-