ControlChar (JHOVE ASCII Module HUL 1.4.1 API)

java.lang.Object
- java.lang.Enum<ControlChar>
- - edu.harvard.hul.ois.jhove.module.ascii.ControlChar

All Implemented Interfaces:

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

Carl Wilson carlwilson AT github

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACK`
`APC`
`BEL`
`BPH`
`BS`
`CAN`
`CCH`
`CR`
`CSI`
`DC1`
`DC2`
`DC3`
`DC4`
`DCS`
`DEL`
`DLE`
`EM`
`ENQ`
`EOT`
`EPA`
`ESA`
`ESC`
`ETB`
`ETX`
`FF`
`FS`
`GS`
`HOP`
`HT`
`HTJ`
`HTS`
`IND`
`LF`
`MW`
`NAK`
`NBH`
`NEL`
`NUL` 7 bit ASCII 0x00 - 0x1F + 0x7F
`OSC`
`PAD` Unicode Extensions 0x80 - 0x9F Currently not used
`PLD`
`PLU`
`PM`
`PU1`
`PU2`
`RI`
`RS`
`SCI`
`SGCI`
`SI`
`SO`
`SOH`
`SOS`
`SPA`
`SS2`
`SS3`
`SSA`
`ST`
`STS`
`STX`
`SUB`
`SYN`
`US`
`VT`
`VTS`

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`ansiName` The control character's ANSI name
`static EnumSet<ControlChar>`	`ASCII` Set of ASCII 7 bit Control Chars
`String`	`code` The three character code
`String`	`mnemonic` JHOVE's reporting mnemonic, the code followed by the int value in hex.
`static String`	`PROP_NAME` JHOVE reporting property name
`static EnumSet<ControlChar>`	`UNICODE` Set of Unicode Control Chars, `ASCII` + `UNICODE_EXTENSIONS`
`static EnumSet<ControlChar>`	`UNICODE_EXTENSIONS` Set of Control Chars that are only Unicode
`int`	`value` The byte value of the character.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ControlChar`	`asciiFromInt(int charVal)` Returns the appropriate ASCII control character for an int character value.
`static ControlChar`	`fromMnemonic(String mnemonic)`
`static boolean`	`isLineEndChar(ControlChar toTest)` Tests whether the passed ControlChar toTest is a line ending character.
`static ControlChar`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ControlChar[]`	`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

NUL
```
public static final ControlChar NUL
```
7 bit ASCII 0x00 - 0x1F + 0x7F

SOH
```
public static final ControlChar SOH
```

STX
```
public static final ControlChar STX
```

ETX
```
public static final ControlChar ETX
```

EOT
```
public static final ControlChar EOT
```

ENQ
```
public static final ControlChar ENQ
```

ACK
```
public static final ControlChar ACK
```

BEL
```
public static final ControlChar BEL
```

BS
```
public static final ControlChar BS
```

HT
```
public static final ControlChar HT
```

LF
```
public static final ControlChar LF
```

VT
```
public static final ControlChar VT
```

FF
```
public static final ControlChar FF
```

CR
```
public static final ControlChar CR
```

SO
```
public static final ControlChar SO
```

SI
```
public static final ControlChar SI
```

DLE
```
public static final ControlChar DLE
```

DC1
```
public static final ControlChar DC1
```

DC2
```
public static final ControlChar DC2
```

DC3
```
public static final ControlChar DC3
```

DC4
```
public static final ControlChar DC4
```

NAK
```
public static final ControlChar NAK
```

SYN
```
public static final ControlChar SYN
```

ETB
```
public static final ControlChar ETB
```

CAN
```
public static final ControlChar CAN
```

EM
```
public static final ControlChar EM
```

SUB
```
public static final ControlChar SUB
```

ESC
```
public static final ControlChar ESC
```

FS
```
public static final ControlChar FS
```

GS
```
public static final ControlChar GS
```

RS
```
public static final ControlChar RS
```

US
```
public static final ControlChar US
```

DEL
```
public static final ControlChar DEL
```

PAD
```
public static final ControlChar PAD
```
Unicode Extensions 0x80 - 0x9F Currently not used

HOP
```
public static final ControlChar HOP
```

BPH
```
public static final ControlChar BPH
```

NBH
```
public static final ControlChar NBH
```

IND
```
public static final ControlChar IND
```

NEL
```
public static final ControlChar NEL
```

SSA
```
public static final ControlChar SSA
```

ESA
```
public static final ControlChar ESA
```

HTS
```
public static final ControlChar HTS
```

HTJ
```
public static final ControlChar HTJ
```

VTS
```
public static final ControlChar VTS
```

PLD
```
public static final ControlChar PLD
```

PLU
```
public static final ControlChar PLU
```

RI
```
public static final ControlChar RI
```

SS2
```
public static final ControlChar SS2
```

SS3
```
public static final ControlChar SS3
```

DCS
```
public static final ControlChar DCS
```

PU1
```
public static final ControlChar PU1
```

PU2
```
public static final ControlChar PU2
```

STS
```
public static final ControlChar STS
```

CCH
```
public static final ControlChar CCH
```

MW
```
public static final ControlChar MW
```

SPA
```
public static final ControlChar SPA
```

EPA
```
public static final ControlChar EPA
```

SOS
```
public static final ControlChar SOS
```

SGCI
```
public static final ControlChar SGCI
```

SCI
```
public static final ControlChar SCI
```

CSI
```
public static final ControlChar CSI
```

ST
```
public static final ControlChar ST
```

OSC
```
public static final ControlChar OSC
```

PM
```
public static final ControlChar PM
```

APC
```
public static final ControlChar APC
```

Field Detail
- PROP_NAME
```
public static final String PROP_NAME
```
  JHOVE reporting property name
  
  See Also:
  
  Constant Field Values
- ASCII
```
public static final EnumSet<ControlChar> ASCII
```
  Set of ASCII 7 bit Control Chars
- UNICODE_EXTENSIONS
```
public static final EnumSet<ControlChar> UNICODE_EXTENSIONS
```
  Set of Control Chars that are only Unicode
- UNICODE
```
public static final EnumSet<ControlChar> UNICODE
```
  Set of Unicode Control Chars, ASCII + UNICODE_EXTENSIONS
- code
```
public final String code
```
  The three character code
- value
```
public final int value
```
  The byte value of the character.
- ansiName
```
public final String ansiName
```
  The control character's ANSI name
- mnemonic
```
public final String mnemonic
```
  JHOVE's reporting mnemonic, the code followed by the int value in hex.

Method Detail
- values
```
public static ControlChar[] 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 (ControlChar c : ControlChar.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static ControlChar 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
- isLineEndChar
```
public static final boolean isLineEndChar(ControlChar toTest)
```
  Tests whether the passed ControlChar toTest is a line ending character.
  
  Parameters:
  
  toTest - the ControlChar to test
  
  Returns:
  
  true if toTest is a CR or LF character.
- asciiFromInt
```
public static final ControlChar asciiFromInt(int charVal)
```
  Returns the appropriate ASCII control character for an int character value.
  
  Parameters:
  
  charVal - the int value of a possible ASCII character
  
  Returns:
  
  the control character with matching ASCII value or null if the value is out of the ASCII control character range.
- fromMnemonic
```
public static final ControlChar fromMnemonic(String mnemonic)
```

Enum ControlChar

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NUL

SOH

STX

ETX

EOT

ENQ

ACK

BEL

BS

HT

LF

VT

FF

CR

SO

SI

DLE

DC1

DC2

DC3

DC4

NAK

SYN

ETB

CAN

EM

SUB

ESC

FS

GS

RS

US

DEL

PAD

HOP

BPH

NBH

IND

NEL

SSA

ESA

HTS

HTJ

VTS

PLD

PLU

RI

SS2

SS3

DCS

PU1

PU2

STS

CCH

MW

SPA

EPA

SOS

SGCI

SCI

CSI

ST

OSC

PM

APC

Field Detail

PROP_NAME

ASCII

UNICODE_EXTENSIONS

UNICODE

code

value

ansiName