com.palantir.giraffe.file.base

Class OpenFlags

java.lang.Object

com.palantir.giraffe.file.base.OpenFlags

public class OpenFlags
extends Object

Container for standard OpenOptions.

This class may be extended by file system implementations that add custom options. Use setStandardOption(OpenFlags, OpenOption) to set standard options in custom subclasses.

See Also:

StandardOpenOption, LinkOption

Field Summary

Fields

Modifier and Type	Field and Description
boolean	append
boolean	create
boolean	createNew
boolean	deleteOnClose
boolean	dsync
boolean	followLinks
boolean	read
boolean	sparse
boolean	sync
boolean	truncateExisting
boolean	write

Constructor Summary

Constructors

Constructor and Description
OpenFlags()

Method Summary

Methods

Modifier and Type	Method and Description
static OpenFlags	fromOptions(Iterable<? extends OpenOption> options) Converts the specified options to flags.
static OpenFlags	fromOptions(OpenOption... options) Converts the specified options to flags.
protected static boolean	setStandardOption(OpenFlags flags, OpenOption option) Sets a standard option in flags.
static OpenFlags	validateFromOptions(Iterable<? extends OpenOption> options) Converts the specified options to flags, sets missing implied flags, and checks for invalid combinations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

read

public boolean read

write

public boolean write

append

public boolean append

create

public boolean create

createNew

public boolean createNew

truncateExisting

public boolean truncateExisting

deleteOnClose

public boolean deleteOnClose

sparse

public boolean sparse

dsync

public boolean dsync

sync

public boolean sync

followLinks

public boolean followLinks

Constructor Detail

OpenFlags

public OpenFlags()

Method Detail

validateFromOptions

public static OpenFlags validateFromOptions(Iterable<? extends OpenOption> options)

Converts the specified options to flags, sets missing implied flags, and checks for invalid combinations.

Parameters:

options - the options to convert and validate

Throws:

IllegalArgumentException - if the iterable contains an invalid combination of options

See Also:

Files.newByteChannel

fromOptions

public static OpenFlags fromOptions(OpenOption... options)

Converts the specified options to flags.

Parameters:

options - the options to convert

Throws:

UnsupportedOperationException - if an unsupported option is specified

fromOptions

public static OpenFlags fromOptions(Iterable<? extends OpenOption> options)

Converts the specified options to flags.

Parameters:

options - the options to convert

Throws:

UnsupportedOperationException - if an unsupported option is specified

setStandardOption

protected static boolean setStandardOption(OpenFlags flags,
                        OpenOption option)

Sets a standard option in flags.

Parameters:

flags - the flags object in which to set the option

option - the standard option to set

Returns:

true if the option was recognized and set or false if the option was non-standard.