HeaderMode (Configurate 4.0.0 (all modules))

java.lang.Object
- java.lang.Enum<HeaderMode>
- - org.spongepowered.configurate.loader.HeaderMode

All Implemented Interfaces:

Serializable, Comparable<HeaderMode>
```
public enum HeaderMode
extends Enum<HeaderMode>
```
Modes which ConfigurationLoaders can use to manipulate headers when loading/saving.

Since:

4.0.0

Enum Constant Summary

Enum Constants
Enum Constant	Description
`NONE`	Ignore any header present in input, and do not output any header.
`PRESERVE`	Use the header loaded from an existing file, replacing any header set in the options.
`PRESET`	Ignore any header present in input, and output a header if one has been set in the options.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static HeaderMode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static HeaderMode[]`	`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
  - PRESERVE
```
public static final HeaderMode PRESERVE
```
    Use the header loaded from an existing file, replacing any header set in the options.
  - PRESET
```
public static final HeaderMode PRESET
```
    Ignore any header present in input, and output a header if one has been set in the options.
  - NONE
```
public static final HeaderMode NONE
```
    Ignore any header present in input, and do not output any header.
- Method Detail
  - values
```
public static HeaderMode[] 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 (HeaderMode c : HeaderMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HeaderMode 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