FileOptionValue (Clean Content SDK 8.5.6.01.211123)

java.lang.Object
- net.bitform.api.options.FileOptionValue

```
public final class FileOptionValue
extends java.lang.Object
```
An object the represents all allowable ways to define a stream of bytes. This class is used only for getting the value of a FileOption since a seperate setOption methods exist for each representation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTEBUFFER`
`static int`	`FILE`
`static int`	`FILECHANNEL`
`static int`	`INPUTSTREAM`
`static int`	`OUTPUTSTREAM`
`static int`	`SIMPLECHANNEL`
`static int`	`URL`

Constructor Summary

Constructors
Constructor and Description
`FileOptionValue(java.nio.ByteBuffer bytebuffer)`
`FileOptionValue(java.io.File file)`
`FileOptionValue(java.nio.channels.FileChannel filechannel)`
`FileOptionValue(java.io.InputStream inputstream)`
`FileOptionValue(java.io.OutputStream outputstream)`
`FileOptionValue(SimpleChannel simplechannel)`
`FileOptionValue(java.net.URL url)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Override equals
`java.nio.ByteBuffer`	`getByteBuffer()` Returns the value if it is a ByteBuffer
`java.io.File`	`getFile()` Returns the value if it is a File
`java.nio.channels.FileChannel`	`getFileChannel()` Returns the value if it is a FileChannel
`java.io.InputStream`	`getInputStream()` Returns the value if it is a InputStream
`java.io.OutputStream`	`getOutputStream()` Returns the value if it is a OutputStream
`SimpleChannel`	`getSimpleChannel()` Returns the value if it is a SimpleChannel
`int`	`getType()` Gets the type of the value
`java.net.URL`	`getURL()` Returns the value if it is a URL
`boolean`	`isByteBuffer()` Test whether the value is a ByteBuffer
`boolean`	`isFile()` Test whether the value is a File
`boolean`	`isFileChannel()` Test whether the value is a FileChannel
`boolean`	`isInputStream()` Test whether the value is a InputStream
`boolean`	`isOutputStream()` Test whether the value is a OutputStream
`boolean`	`isSimpleChannel()` Test whether the value is a SimpleChannel
`boolean`	`isURL()` Test whether the value is a URL
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILE
```
public static final int FILE
```
    See Also:
    
    Constant Field Values
  - URL
```
public static final int URL
```
    See Also:
    
    Constant Field Values
  - INPUTSTREAM
```
public static final int INPUTSTREAM
```
    See Also:
    
    Constant Field Values
  - FILECHANNEL
```
public static final int FILECHANNEL
```
    See Also:
    
    Constant Field Values
  - BYTEBUFFER
```
public static final int BYTEBUFFER
```
    See Also:
    
    Constant Field Values
  - SIMPLECHANNEL
```
public static final int SIMPLECHANNEL
```
    See Also:
    
    Constant Field Values
  - OUTPUTSTREAM
```
public static final int OUTPUTSTREAM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileOptionValue
```
public FileOptionValue(java.io.File file)
```
  - FileOptionValue
```
public FileOptionValue(java.net.URL url)
```
  - FileOptionValue
```
public FileOptionValue(java.io.InputStream inputstream)
```
  - FileOptionValue
```
public FileOptionValue(java.nio.channels.FileChannel filechannel)
```
  - FileOptionValue
```
public FileOptionValue(java.nio.ByteBuffer bytebuffer)
```
  - FileOptionValue
```
public FileOptionValue(SimpleChannel simplechannel)
```
  - FileOptionValue
```
public FileOptionValue(java.io.OutputStream outputstream)
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Override equals
    
    Overrides:
    
    equals in class java.lang.Object
  - getType
```
public int getType()
```
    Gets the type of the value
    
    Returns:
    
    One the the public static final types defined by this class
  - isFile
```
public boolean isFile()
```
    Test whether the value is a File
    
    Returns:
    
    true if the value is a File, false otherwise
  - isURL
```
public boolean isURL()
```
    Test whether the value is a URL
    
    Returns:
    
    true if the value is a URL, false otherwise
  - isInputStream
```
public boolean isInputStream()
```
    Test whether the value is a InputStream
    
    Returns:
    
    true if the value is a InputStream, false otherwise
  - isFileChannel
```
public boolean isFileChannel()
```
    Test whether the value is a FileChannel
    
    Returns:
    
    true if the value is a FileChannel, false otherwise
  - isByteBuffer
```
public boolean isByteBuffer()
```
    Test whether the value is a ByteBuffer
    
    Returns:
    
    true if the value is a ByteBuffer, false otherwise
  - isSimpleChannel
```
public boolean isSimpleChannel()
```
    Test whether the value is a SimpleChannel
    
    Returns:
    
    true if the value is a SimpleChannel, false otherwise
  - isOutputStream
```
public boolean isOutputStream()
```
    Test whether the value is a OutputStream
    
    Returns:
    
    true if the value is a OutputStream, false otherwise
  - getFile
```
public java.io.File getFile()
```
    Returns the value if it is a File
    
    Returns:
    
    Returns the File the value represents or NULL is the value represents some other type.
  - getURL
```
public java.net.URL getURL()
```
    Returns the value if it is a URL
    
    Returns:
    
    Returns the URL the value represents or NULL is the value represents some other type.
  - getInputStream
```
public java.io.InputStream getInputStream()
```
    Returns the value if it is a InputStream
    
    Returns:
    
    Returns the InputStream the value represents or NULL is the value represents some other type.
  - getFileChannel
```
public java.nio.channels.FileChannel getFileChannel()
```
    Returns the value if it is a FileChannel
    
    Returns:
    
    Returns the FileChannel the value represents or NULL is the value represents some other type.
  - getByteBuffer
```
public java.nio.ByteBuffer getByteBuffer()
```
    Returns the value if it is a ByteBuffer
    
    Returns:
    
    Returns the ByteBuffer the value represents or NULL is the value represents some other type.
  - getSimpleChannel
```
public SimpleChannel getSimpleChannel()
```
    Returns the value if it is a SimpleChannel
    
    Returns:
    
    Returns the SimpleChannel the value represents or NULL is the value represents some other type.
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
```
    Returns the value if it is a OutputStream
    
    Returns:
    
    Returns the OutputStream the value represents or NULL is the value represents some other type.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FileOptionValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE

URL

INPUTSTREAM

FILECHANNEL

BYTEBUFFER

SIMPLECHANNEL

OUTPUTSTREAM

Constructor Detail

FileOptionValue

FileOptionValue

FileOptionValue

FileOptionValue

FileOptionValue

FileOptionValue

FileOptionValue

Method Detail

equals

getType

isFile

isURL

isInputStream

isFileChannel

isByteBuffer

isSimpleChannel

isOutputStream

getFile

getURL

getInputStream

getFileChannel

getByteBuffer

getSimpleChannel

getOutputStream

toString