ch.systemsx.cisd.hdf5

Enum IHDF5WriterConfigurator.FileFormatVersionBounds

java.lang.Object

java.lang.Enum<IHDF5WriterConfigurator.FileFormatVersionBounds>

ch.systemsx.cisd.hdf5.IHDF5WriterConfigurator.FileFormatVersionBounds

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IHDF5WriterConfigurator.FileFormatVersionBounds>

Enclosing interface:

IHDF5WriterConfigurator

public static enum IHDF5WriterConfigurator.FileFormatVersionBounds
extends java.lang.Enum<IHDF5WriterConfigurator.FileFormatVersionBounds>

Enum for specifying the file format version boundaries.

For details, see https://www.hdfgroup.org/wp-content/uploads/2018/04/RFC-Setting-Bounds-for-Object-Creation-in-HDF5-1-10-0.pdf

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARLIEST_LATEST The library will create objects with the earliest possible format versions. The library will allow objects to be created with the latest format versions available to the current library release version. With this setting, there is no upper limit on the format version to use. This is the library default setting and provides the greatest format compatibility.
EARLIEST_V1_10 The library will create objects with the earliest possible format versions. The library will allow objects to be created with the latest format versions available to library release version 1.10.
EARLIEST_V1_8 The library will create objects with the earliest possible format versions. The library will allow objects to be created with the latest format versions available to library release version 1.8. API calls that create objects or features that is available to versions of the library greater than release version 1.8 will fail.<.li>
LATEST_LATEST The library will create objects with the latest format versions available to the current library release version. This setting allows users to take advantage of the latest features and performance enhancements in the current library. Earlier versions of the library than the current one may not be able to access objects created with this setting.
V1_10_LATEST The library will create objects with the latest format versions available to the current library release version. This setting allows users to take advantage of the latest features and performance enhancements in the current library. Earlier versions of the library than the current one may not be able to access objects created with this setting.
V1_10_V1_10 The library will create objects with the latest format versions available to library release version 1.10. This setting allows users to take advantage of the latest features and performance enhancements in the library version 1.10. Earlier versions of the library than 1.10 may not be able to access objects created with this setting.
V1_8_LATEST The library will create objects with the latest format versions available to library release version 1.8. The library will allow objects to be created with the latest format versions available to the current library release version. Earlier versions of the library than 1.8 may not be able to access objects created with this setting.
V1_8_V1_10 The library will create objects with the latest format versions available to library release version 1.8. The library will allow objects to be created with the latest format versions available to library release version 1.10. Earlier versions of the library than 1.8 may not be able to access objects created with this setting.
V1_8_V1_8 The library will create objects with the latest format versions available to library release version 1.8. The library will allow objects to be created with the latest format versions available to library release version 1.8. Earlier versions of the library than 1.8 may not be able to access objects created with this setting. API calls that create objects or features that is available to versions of the library greater than release version 1.8 will fail.<.li>

Method Summary

Modifier and Type	Method and Description
static IHDF5WriterConfigurator.FileFormatVersionBounds	getDefault()
IHDF5WriterConfigurator.FileFormatVersion	getHighBound()
IHDF5WriterConfigurator.FileFormatVersion	getLowBound()
static IHDF5WriterConfigurator.FileFormatVersionBounds	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IHDF5WriterConfigurator.FileFormatVersionBounds[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EARLIEST_V1_8

public static final IHDF5WriterConfigurator.FileFormatVersionBounds EARLIEST_V1_8

• The library will create objects with the earliest possible format versions.
• The library will allow objects to be created with the latest format versions available to library release version 1.8.
• API calls that create objects or features that is available to versions of the library greater than release version 1.8 will fail.<.li>

EARLIEST_V1_10

public static final IHDF5WriterConfigurator.FileFormatVersionBounds EARLIEST_V1_10

• The library will create objects with the earliest possible format versions.
• The library will allow objects to be created with the latest format versions available to library release version 1.10.

EARLIEST_LATEST

public static final IHDF5WriterConfigurator.FileFormatVersionBounds EARLIEST_LATEST

• The library will create objects with the earliest possible format versions.
• The library will allow objects to be created with the latest format versions available to the current library release version.
• With this setting, there is no upper limit on the format version to use.
• This is the library default setting and provides the greatest format compatibility.

V1_8_V1_8

public static final IHDF5WriterConfigurator.FileFormatVersionBounds V1_8_V1_8

• The library will create objects with the latest format versions available to library release version 1.8.
• The library will allow objects to be created with the latest format versions available to library release version 1.8.
• Earlier versions of the library than 1.8 may not be able to access objects created with this setting.
• API calls that create objects or features that is available to versions of the library greater than release version 1.8 will fail.<.li>

V1_8_V1_10

public static final IHDF5WriterConfigurator.FileFormatVersionBounds V1_8_V1_10

• The library will create objects with the latest format versions available to library release version 1.8.
• The library will allow objects to be created with the latest format versions available to library release version 1.10.
• Earlier versions of the library than 1.8 may not be able to access objects created with this setting.

V1_8_LATEST

public static final IHDF5WriterConfigurator.FileFormatVersionBounds V1_8_LATEST

• The library will create objects with the latest format versions available to library release version 1.8.
• The library will allow objects to be created with the latest format versions available to the current library release version.
• Earlier versions of the library than 1.8 may not be able to access objects created with this setting.

V1_10_V1_10

public static final IHDF5WriterConfigurator.FileFormatVersionBounds V1_10_V1_10

• The library will create objects with the latest format versions available to library release version 1.10.
• This setting allows users to take advantage of the latest features and performance enhancements in the library version 1.10.
• Earlier versions of the library than 1.10 may not be able to access objects created with this setting.

V1_10_LATEST

public static final IHDF5WriterConfigurator.FileFormatVersionBounds V1_10_LATEST

• The library will create objects with the latest format versions available to the current library release version.
• This setting allows users to take advantage of the latest features and performance enhancements in the current library.
• Earlier versions of the library than the current one may not be able to access objects created with this setting.

LATEST_LATEST

public static final IHDF5WriterConfigurator.FileFormatVersionBounds LATEST_LATEST

• The library will create objects with the latest format versions available to the current library release version.
• This setting allows users to take advantage of the latest features and performance enhancements in the current library.
• Earlier versions of the library than the current one may not be able to access objects created with this setting.

Method Detail

values

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

Returns:

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

valueOf

public static IHDF5WriterConfigurator.FileFormatVersionBounds valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLowBound

public IHDF5WriterConfigurator.FileFormatVersion getLowBound()

Returns:

The lower boundary of the file format version.

getHighBound

public IHDF5WriterConfigurator.FileFormatVersion getHighBound()

Returns:

The upper boundary of the file format version.

getDefault

public static IHDF5WriterConfigurator.FileFormatVersionBounds getDefault()

Returns:

The default file format version boundaries used by the HDF5 library.