org.janelia.saalfeldlab.n5.universe

Enum KeyValueAccessBackend

java.lang.Object

java.lang.Enum<KeyValueAccessBackend>

org.janelia.saalfeldlab.n5.universe.KeyValueAccessBackend

All Implemented Interfaces:

Serializable, Comparable<KeyValueAccessBackend>, Predicate<URI>, org.apache.commons.lang3.function.TriFunction<URI,N5Factory,Boolean,org.janelia.saalfeldlab.n5.KeyValueAccess>

public enum KeyValueAccessBackend
extends Enum<KeyValueAccessBackend>
implements Predicate<URI>, org.apache.commons.lang3.function.TriFunction<URI,N5Factory,Boolean,org.janelia.saalfeldlab.n5.KeyValueAccess>

Enum to discover and provide KeyValueAccess for N5Readers and N5Writers. IMPORTANT: If ever new KeyValueAccess backends are adding, they MUST be re-ordered such that the earliest predicates are the most restrictive, and the later predicates are the least restrictive. This ensures that when iterating through the values of KeyValueAccessBackend you can test them in order, and stop at the first KeyValueAccess that is generated.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AWS
FILE
GOOGLE_CLOUD
HTTP

Method Summary

Modifier and Type	Method and Description
org.janelia.saalfeldlab.n5.KeyValueAccess	apply(URI uri, N5Factory factory, Boolean readOnly)
static org.janelia.saalfeldlab.n5.KeyValueAccess	getKeyValueAccess(URI uri, boolean readOnly) Test the provided URI to and return the appropriate KeyValueAccess.
boolean	test(URI uri)
static KeyValueAccessBackend	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyValueAccessBackend[]	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 java.util.function.Predicate

and, isEqual, negate, or

Methods inherited from interface org.apache.commons.lang3.function.TriFunction

andThen

Enum Constant Detail

GOOGLE_CLOUD

public static final KeyValueAccessBackend GOOGLE_CLOUD

AWS

public static final KeyValueAccessBackend AWS

HTTP

public static final KeyValueAccessBackend HTTP

FILE

public static final KeyValueAccessBackend FILE

Method Detail

values

public static KeyValueAccessBackend[] 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 (KeyValueAccessBackend c : KeyValueAccessBackend.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyValueAccessBackend 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

apply

public org.janelia.saalfeldlab.n5.KeyValueAccess apply(URI uri,
                                                       N5Factory factory,
                                                       Boolean readOnly)

Specified by:

apply in interface org.apache.commons.lang3.function.TriFunction<URI,N5Factory,Boolean,org.janelia.saalfeldlab.n5.KeyValueAccess>

test

public boolean test(URI uri)

Specified by:

test in interface Predicate<URI>

getKeyValueAccess

@Nullable
public static org.janelia.saalfeldlab.n5.KeyValueAccess getKeyValueAccess(URI uri,
                                                                                    boolean readOnly)

Test the provided URI to and return the appropriate KeyValueAccess. If no appropriate KeyValueAccess is found, may be null

Parameters:

uri - to create a KeyValueAccess from.

Returns:

the KeyValueAccess and container path, or null if none are valid