Status (CPE Parser 2.1.0 API)

java.lang.Object
- java.lang.Enum<Status>
- - us.springett.parsers.cpe.util.Status

All Implemented Interfaces:

Serializable, Comparable<Status>
```
public enum Status
extends Enum<Status>
```
Author:

Jeremy Long

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ASTERISK_SEQUENCE` A CPE component may not contain a sequence of asterisk characters.
`EMPTY` The CPE component is either empty or null.
`INVALID` The CPE value is invalid.
`INVALID_PART` The CPE has an invalid part defined.
`NON_PRINTABLE` A CPE component must only contain printable characters.
`SINGLE_QUOTED_HYPHEN` A CPE component cannot be a single quoted hyphen.
`TOO_FEW_ELEMENTS` The CPE has too few components.
`TOO_MANY_ELEMENTS` The CPE has too many components.
`UNQUOTED_ASTERISK` Unquoted asterisk characters are not allowed except at the beginning or end of a CPE component.
`UNQUOTED_QUESTION_MARK` Unquoted question marks are not allowed except at the beginning or end of a CPE component.
`VALID` The CPE or CPE component is valid.
`WHITESPACE` A CPE component must not contain whitespace.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMessage()` Gets the status message.
`boolean`	`isValid()` Returns whether or not the status is considered valid.
`static Status`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Status[]`	`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
  - VALID
```
public static final Status VALID
```
    The CPE or CPE component is valid.
  - UNQUOTED_QUESTION_MARK
```
public static final Status UNQUOTED_QUESTION_MARK
```
    Unquoted question marks are not allowed except at the beginning or end of a CPE component.
  - UNQUOTED_ASTERISK
```
public static final Status UNQUOTED_ASTERISK
```
    Unquoted asterisk characters are not allowed except at the beginning or end of a CPE component.
  - ASTERISK_SEQUENCE
```
public static final Status ASTERISK_SEQUENCE
```
    A CPE component may not contain a sequence of asterisk characters.
  - NON_PRINTABLE
```
public static final Status NON_PRINTABLE
```
    A CPE component must only contain printable characters.
  - WHITESPACE
```
public static final Status WHITESPACE
```
    A CPE component must not contain whitespace.
  - SINGLE_QUOTED_HYPHEN
```
public static final Status SINGLE_QUOTED_HYPHEN
```
    A CPE component cannot be a single quoted hyphen.
  - EMPTY
```
public static final Status EMPTY
```
    The CPE component is either empty or null.
  - TOO_MANY_ELEMENTS
```
public static final Status TOO_MANY_ELEMENTS
```
    The CPE has too many components.
  - TOO_FEW_ELEMENTS
```
public static final Status TOO_FEW_ELEMENTS
```
    The CPE has too few components.
  - INVALID_PART
```
public static final Status INVALID_PART
```
    The CPE has an invalid part defined.
  - INVALID
```
public static final Status INVALID
```
    The CPE value is invalid.
- Method Detail
  - values
```
public static Status[] 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 (Status c : Status.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Status 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
  - isValid
```
public boolean isValid()
```
    Returns whether or not the status is considered valid.
    
    Returns:
    
    true if the status is valid; otherwise false
  - getMessage
```
public String getMessage()
```
    Gets the status message.
    
    Returns:
    
    the status message

Enum Status

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

VALID

UNQUOTED_QUESTION_MARK

UNQUOTED_ASTERISK

ASTERISK_SEQUENCE

NON_PRINTABLE

WHITESPACE

SINGLE_QUOTED_HYPHEN

EMPTY

TOO_MANY_ELEMENTS

TOO_FEW_ELEMENTS

INVALID_PART

INVALID

Method Detail

values

valueOf

isValid

getMessage