FileContext.PropertyKey (simple-file-back 0.8 API)

java.lang.Object
- java.lang.Enum<FileContext.PropertyKey>
- - com.github.jinahya.simple.file.back.FileContext.PropertyKey

All Implemented Interfaces:

Serializable, Comparable<FileContext.PropertyKey>

Enclosing interface:

FileContext
```
public static enum FileContext.PropertyKey
extends Enum<FileContext.PropertyKey>
```
Properties can be configured within file contexts.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`FILE_OPERATION_SUPPLIER` A constant for the key of a property whose value is an instance of `Supplier<FileOperation>` which supplies the target operation.
`PATH_NAME_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<String>` which consumes the path name.
`PATH_NAME_SUPPLIER` A constant for the key of a property whose values si an instance of `Supplier<String>` which supplies the path name.
`SOURCE_CHANNEL_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<ReadableByteChannel>` which consumes source file channel.
`SOURCE_CHANNEL_SUPPLIER` A constant for the key of a property whose value is an instance of `Supplier<RedableByteChanel>` which supplies the source file channel.
`SOURCE_COPIED_CONSUMER` A constants for the key of a property whose value is an instance of `Consumer<Long>` which consumes the number of bytes copied from the source file part.
`SOURCE_KEY_SUPPLIER` A constant for the key of a property whose value is an instance of `Supplier<ByteBuffer>` which supplies the key bytes for locating the source file part.
`SOURCE_OBJECT_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<Object>` which consumes an implementation specific type of source file reference.
`TARGET_CHANNEL_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<WritableByteChannel>` which consumes the target file channel.
`TARGET_CHANNEL_SUPPLIER` A constant for the key of a property whose value is an instance of `Supplier<WritableByteChannel>` which supplies a target file channel.
`TARGET_COPIED_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<Long>` which consumes the number of bytes copied to target file part.
`TARGET_KEY_SUPPLIER` A constant for the key of a property whose value is an instance of `Supplier<ByteBuffer>` which supplies the key bytes the locating the target file part.
`TARGET_OBJECT_CONSUMER` A constant for the key of a property whose value is an instance of `Consumer<Object>` which consumes an implementation specific type of target file reference.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FileContext.PropertyKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FileContext.PropertyKey[]`	`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
  - FILE_OPERATION_SUPPLIER
```
public static final FileContext.PropertyKey FILE_OPERATION_SUPPLIER
```
    A constant for the key of a property whose value is an instance of Supplier<FileOperation> which supplies the target operation.
  - PATH_NAME_CONSUMER
```
public static final FileContext.PropertyKey PATH_NAME_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<String> which consumes the path name.
  - PATH_NAME_SUPPLIER
```
public static final FileContext.PropertyKey PATH_NAME_SUPPLIER
```
    A constant for the key of a property whose values si an instance of Supplier<String> which supplies the path name.
  - SOURCE_CHANNEL_CONSUMER
```
public static final FileContext.PropertyKey SOURCE_CHANNEL_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<ReadableByteChannel> which consumes source file channel.
  - TARGET_CHANNEL_CONSUMER
```
public static final FileContext.PropertyKey TARGET_CHANNEL_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<WritableByteChannel> which consumes the target file channel.
  - SOURCE_CHANNEL_SUPPLIER
```
public static final FileContext.PropertyKey SOURCE_CHANNEL_SUPPLIER
```
    A constant for the key of a property whose value is an instance of Supplier<RedableByteChanel> which supplies the source file channel.
  - TARGET_CHANNEL_SUPPLIER
```
public static final FileContext.PropertyKey TARGET_CHANNEL_SUPPLIER
```
    A constant for the key of a property whose value is an instance of Supplier<WritableByteChannel> which supplies a target file channel.
  - SOURCE_COPIED_CONSUMER
```
public static final FileContext.PropertyKey SOURCE_COPIED_CONSUMER
```
    A constants for the key of a property whose value is an instance of Consumer<Long> which consumes the number of bytes copied from the source file part.
  - TARGET_COPIED_CONSUMER
```
public static final FileContext.PropertyKey TARGET_COPIED_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<Long> which consumes the number of bytes copied to target file part.
  - SOURCE_KEY_SUPPLIER
```
public static final FileContext.PropertyKey SOURCE_KEY_SUPPLIER
```
    A constant for the key of a property whose value is an instance of Supplier<ByteBuffer> which supplies the key bytes for locating the source file part.
  - TARGET_KEY_SUPPLIER
```
public static final FileContext.PropertyKey TARGET_KEY_SUPPLIER
```
    A constant for the key of a property whose value is an instance of Supplier<ByteBuffer> which supplies the key bytes the locating the target file part.
  - SOURCE_OBJECT_CONSUMER
```
public static final FileContext.PropertyKey SOURCE_OBJECT_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<Object> which consumes an implementation specific type of source file reference.
  - TARGET_OBJECT_CONSUMER
```
public static final FileContext.PropertyKey TARGET_OBJECT_CONSUMER
```
    A constant for the key of a property whose value is an instance of Consumer<Object> which consumes an implementation specific type of target file reference.
- Method Detail
  - values
```
public static FileContext.PropertyKey[] 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 (FileContext.PropertyKey c : FileContext.PropertyKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FileContext.PropertyKey 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

Enum FileContext.PropertyKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FILE_OPERATION_SUPPLIER

PATH_NAME_CONSUMER

PATH_NAME_SUPPLIER

SOURCE_CHANNEL_CONSUMER

TARGET_CHANNEL_CONSUMER

SOURCE_CHANNEL_SUPPLIER

TARGET_CHANNEL_SUPPLIER

SOURCE_COPIED_CONSUMER

TARGET_COPIED_CONSUMER

SOURCE_KEY_SUPPLIER

TARGET_KEY_SUPPLIER

SOURCE_OBJECT_CONSUMER

TARGET_OBJECT_CONSUMER

Method Detail

values

valueOf