OutMode ( Frame4J -- the Java framework de.frame4j... )

java.lang.Object
- java.lang.Enum<OutMode>
- - de.frame4j.io.OutMode

All Implemented Interfaces:

Serializable, Comparable<OutMode>
```
@MinDoc(copyright="Copyright  2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.50",
        lastModified="4.06.2021",
        usage="use instead of String or int values",
        purpose="values for the possible modes for handling an existing file")
public enum OutMode
extends Enum<OutMode>
```
Values for possible modes of handling (output to) existing files.

If an existing file is to be used for output the usual choices are
- to overwrite,
- to update = to overwrite if certain criteria are met,
- to append to,
- no action (to leave as is),
- create (must not yet exist) or
- ask someone what to do.
This class represents these choices.

© Copyright 2009 Albrecht Weinert
See Also:

App

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPEND` Append at the end of the existing file.
`ASK` Ask what to to if file exists.
`NO_ACTION` No action / no change of an existing file.
`OVERWRITE` Overwrite an existing file.
`UPDATE` Update, Overwrite an existing file if certain criteria are met.

Field Summary

Fields
Modifier and Type Field and Description

String name
The name of this OutMode.

int val
A value for this OutMode.

Fields
Modifier and Type	Field and Description
`String`	`name` The name of this OutMode.
`int`	`val` A value for this OutMode.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OutMode`	`of(CharSequence chose, OutMode def)` Get an OutMode by character sequence.
`String`	`toString()` As String (the name).
`static OutMode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OutMode[]`	`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
  - ASK
```
public static final OutMode ASK
```
    Ask what to to if file exists.
    ask, -1
  - APPEND
```
public static final OutMode APPEND
```
    Append at the end of the existing file.
    append, 6
  - OVERWRITE
```
public static final OutMode OVERWRITE
```
    Overwrite an existing file.
    overwrite, 2
  - UPDATE
```
public static final OutMode UPDATE
```
    Update, Overwrite an existing file if certain criteria are met.
    update", 3
  - NO_ACTION
```
public static final OutMode NO_ACTION
```
    No action / no change of an existing file.
    
    This is sometimes referred to as "e;create" in the sense of "e;must not exist yet".
    
    no change, 1
- Field Detail
  - name
```
public final String name
```
    The name of this OutMode.
  - val
```
public final int val
```
    A value for this OutMode.
- Method Detail
  - values
```
public static OutMode[] 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 (OutMode c : OutMode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OutMode 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
  - toString
```
public String toString()
```
    As String (the name).
    
    Overrides:
    
    toString in class Enum<OutMode>
  - of
```
public static OutMode of(CharSequence chose,
                         OutMode def)
```
    Get an OutMode by character sequence.
    
    This method implements the laziest fit to some English (and two German) keywords. The choice is made on base base of the first or first two non white space characters of chose ignoring case:
    - o?* (0verwrite)
    - y?*, j? (Yes, Ja -> 0verwrite)
    - u?* (Update)
    - n?* (no action)
    - ap* (append)
    - an* (append)
    - a* (ask)
    - * (def or no action)
    Parameters:
    
    chose - how to handle existing files (see above)
    
    def - substitute value if chose is empty or not fitting; null will act as NO_ACTION
    
    Returns:
    
    best fit to chose or def or NO_ACTION

Enum OutMode

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ASK

APPEND

OVERWRITE

UPDATE

NO_ACTION

Field Detail

name

val

Method Detail

values

valueOf

toString

of