java.lang.Object
- java.lang.Enum<SearchFile>
- - com.redwood.scheduler.api.model.enumeration.SearchFile

All Implemented Interfaces:

BaseSchedulerEnumeration<SearchFile,Integer>, SchedulerIntegerEnumeration<SearchFile>, Serializable, Comparable<SearchFile>
```
public enum SearchFile
extends Enum<SearchFile>
implements SchedulerIntegerEnumeration<SearchFile>
```
Options for searching files (Integer Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ByteOffset`	Search lines but from/to a particular byte offset, not line number.
`EntireLine`	The expression must match the entire line (the newline is implicit, and should not be included in the expression).
`IgnoreCase`	Ignore case when comparing.
`LiveView`	Return a possible incomplete last line; terminate all lines by EOL not just between lines.
`NoOptions`	No search options; a litteral search will be performed on the whole file and the first line matched will be returned in a `InputStream`.
`RangeResult`	Return all matching results from the query.
`Reverse`	Search from the end of the file rather than the beginning.
`WildCard`	Make `?` and `*` act as wild cards.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ByteOffsetCode`	The int returned from ByteOffset.getCodeEx().
`static int`	`EntireLineCode`	The int returned from EntireLine.getCodeEx().
`static int`	`IgnoreCaseCode`	The int returned from IgnoreCase.getCodeEx().
`static int`	`LiveViewCode`	The int returned from LiveView.getCodeEx().
`static int`	`NoOptionsCode`	The int returned from NoOptions.getCodeEx().
`static int`	`RangeResultCode`	The int returned from RangeResult.getCodeEx().
`static int`	`ReverseCode`	The int returned from Reverse.getCodeEx().
`static int`	`WildCardCode`	The int returned from WildCard.getCodeEx().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getCodeEx()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`getCodeExInteger()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`getCodeExValue()`	Return the code for the enumeration item as the database type of this enumeration.
`String`	`getDescriptionKey()`	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
`String`	`getTranslationEN()`	Get the English name of this enumeration.
`String`	`getTranslationKey()`	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
`static SearchFile`	`safeValueOf(String value)`	Helper function to return the SearchFile represented by `value`.
`static SearchFile`	`valueOf(int code)`	Helper function to return the SearchFile represented by code.
`static SearchFile`	`valueOf(Integer code)`	Helper function to return the SearchFile represented by code.
`static SearchFile`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SearchFile`	`valueOfCode(String code)`	Helper function to return the SearchFile represented by code.
`static SearchFile[]`	`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

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal

Methods inherited from interface java.lang.Comparable
compareTo

- Enum Constant Detail
  - NoOptions
```
public static final SearchFile NoOptions
```
    No search options; a litteral search will be performed on the whole file and the first line matched will be returned in a InputStream. If you want all matching lines, specify RangeResult.
  - WildCard
```
public static final SearchFile WildCard
```
    Make ? and * act as wild cards.
  - Reverse
```
public static final SearchFile Reverse
```
    Search from the end of the file rather than the beginning.
  - IgnoreCase
```
public static final SearchFile IgnoreCase
```
    Ignore case when comparing.
  - EntireLine
```
public static final SearchFile EntireLine
```
    The expression must match the entire line (the newline is implicit, and should not be included in the expression).
  - RangeResult
```
public static final SearchFile RangeResult
```
    Return all matching results from the query.
  - ByteOffset
```
public static final SearchFile ByteOffset
```
    Search lines but from/to a particular byte offset, not line number.
  - LiveView
```
public static final SearchFile LiveView
```
    Return a possible incomplete last line; terminate all lines by EOL not just between lines. Wait a little if there is no new data.
- Field Detail
  - NoOptionsCode
```
public static final int NoOptionsCode
```
    The int returned from NoOptions.getCodeEx().
    
    See Also:
    
    NoOptions, Constant Field Values
  - WildCardCode
```
public static final int WildCardCode
```
    The int returned from WildCard.getCodeEx().
    
    See Also:
    
    WildCard, Constant Field Values
  - ReverseCode
```
public static final int ReverseCode
```
    The int returned from Reverse.getCodeEx().
    
    See Also:
    
    Reverse, Constant Field Values
  - IgnoreCaseCode
```
public static final int IgnoreCaseCode
```
    The int returned from IgnoreCase.getCodeEx().
    
    See Also:
    
    IgnoreCase, Constant Field Values
  - EntireLineCode
```
public static final int EntireLineCode
```
    The int returned from EntireLine.getCodeEx().
    
    See Also:
    
    EntireLine, Constant Field Values
  - RangeResultCode
```
public static final int RangeResultCode
```
    The int returned from RangeResult.getCodeEx().
    
    See Also:
    
    RangeResult, Constant Field Values
  - ByteOffsetCode
```
public static final int ByteOffsetCode
```
    The int returned from ByteOffset.getCodeEx().
    
    See Also:
    
    ByteOffset, Constant Field Values
  - LiveViewCode
```
public static final int LiveViewCode
```
    The int returned from LiveView.getCodeEx().
    
    See Also:
    
    LiveView, Constant Field Values
- Method Detail
  - values
```
public static SearchFile[] 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 (SearchFile c : SearchFile.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SearchFile 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
  - valueOfCode
```
public static SearchFile valueOfCode(String code)
```
    Helper function to return the SearchFile represented by code. If code is null, empty, or not a valid code then this method will return null.
    
    Parameters:
    
    code - A string that is one of the codes for SearchFile
    
    Returns:
    
    The SearchFile corresponding to code, or null.
  - safeValueOf
```
public static SearchFile safeValueOf(String value)
```
    Helper function to return the SearchFile represented by value. If value is null, or not a valid SearchFile enumeration then this method will return null.
    The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.
    
    Parameters:
    
    value - The string value that corresponds to the requested enumeration value
    
    Returns:
    
    The SearchFile corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static SearchFile valueOf(Integer code)
```
    Helper function to return the SearchFile represented by code. If code is null, or not a valid SearchFile code then this method will return null.
    
    Parameters:
    
    code - Integer that is one of the codes for HandlerAction
    
    Returns:
    
    The SearchFile corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static SearchFile valueOf(int code)
```
    Helper function to return the SearchFile represented by code. If code is not a valid SearchFile code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The SearchFile corresponding to code, or null, if code is not a valid code
  - getCodeEx
```
public int getCodeEx()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeEx in interface SchedulerIntegerEnumeration<SearchFile>
    
    Returns:
    
    the database code for the enumeration
  - getCodeExValue
```
public Integer getCodeExValue()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Return the code for the enumeration item as the database type of this enumeration.
    
    Specified by:
    
    getCodeExValue in interface BaseSchedulerEnumeration<SearchFile,Integer>
    
    Returns:
    
    the enumeration code
  - getCodeExInteger
```
public Integer getCodeExInteger()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeExInteger in interface SchedulerIntegerEnumeration<SearchFile>
    
    Returns:
    
    the database code for the enumeration
  - getTranslationKey
```
public String getTranslationKey()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
    
    Specified by:
    
    getTranslationKey in interface BaseSchedulerEnumeration<SearchFile,Integer>
    
    Returns:
    
    the key.
  - getTranslationEN
```
public String getTranslationEN()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the English name of this enumeration.
    
    Specified by:
    
    getTranslationEN in interface BaseSchedulerEnumeration<SearchFile,Integer>
    
    Returns:
    
    the English name of this enumeration.
  - getDescriptionKey
```
public String getDescriptionKey()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
    
    Specified by:
    
    getDescriptionKey in interface BaseSchedulerEnumeration<SearchFile,Integer>
    
    Returns:
    
    the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

Enum SearchFile

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

NoOptions

WildCard

Reverse

IgnoreCase

EntireLine

RangeResult

ByteOffset

LiveView

Field Detail

NoOptionsCode

WildCardCode

ReverseCode

IgnoreCaseCode

EntireLineCode

RangeResultCode

ByteOffsetCode

LiveViewCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExInteger

getTranslationKey

getTranslationEN

getDescriptionKey