VolumeSpecification (org.openidentityplatform.commons.parent 2.2.3 Documentation)

java.lang.Object
- com.persistit.VolumeSpecification

```
public class VolumeSpecification
extends Object
```
A structure holding all the specification details for a Volume.

Constructor Summary

Constructors
Constructor and Description
`VolumeSpecification(String specification)` Construct a `VolumeSpecification` from the supplied specification string.
`VolumeSpecification(String path, String name, int pageSize, long initialPages, long maximumPages, long extensionPages, boolean create, boolean createOnly, boolean readOnly)` Construct a `VolumeSpecification` having the supplied parameter values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`File`	`getAbsoluteFile()`
`long`	`getExtensionPages()`
`long`	`getExtensionSize()`
`long`	`getId()`
`long`	`getInitialPages()`
`long`	`getInitialSize()`
`long`	`getMaximumPages()`
`long`	`getMaximumSize()`
`String`	`getName()`
`int`	`getPageSize()`
`String`	`getPath()`
`int`	`getVersion()`
`boolean`	`isAliased()`
`boolean`	`isCreate()`
`boolean`	`isCreateOnly()`
`boolean`	`isReadOnly()`
`static String`	`nameFromFile(File file)`
`void`	`setCreate(boolean create)`
`void`	`setCreateOnly(boolean createOnly)`
`void`	`setExtensionSize(long extensionSize)`
`void`	`setId(long value)`
`void`	`setInitialSize(long initialSize)`
`void`	`setMaximumSize(long maximumSize)`
`void`	`setName(String name)`
`void`	`setPageSize(int value)`
`void`	`setPath(String path)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setVersion(int value)`
`String`	`summary()`
`String`	`toString()`

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

- Constructor Detail
  - VolumeSpecification
```
public VolumeSpecification(String path,
                           String name,
                           int pageSize,
                           long initialPages,
                           long maximumPages,
                           long extensionPages,
                           boolean create,
                           boolean createOnly,
                           boolean readOnly)
```
    Construct a VolumeSpecification having the supplied parameter values.
    
    Parameters:
    
    path - File system path to volume file
    
    name - Name of volume. If null the file name in the specified path is used.
    
    pageSize - Page size: one of 1024, 2048, 4096, 8192 or 6384
    
    initialPages - Initial page count
    
    maximumPages - Maximum page count
    
    extensionPages - Number of pages to extend by when file must grow
    
    create - true to allow creation of a new volume
    
    createOnly - true to require creation of a new volume
    
    readOnly - true to open volume file in read-only mode
  - VolumeSpecification
```
public VolumeSpecification(String specification)
                    throws InvalidVolumeSpecificationException
```
    Construct a VolumeSpecification from the supplied specification string. The specification has the form:
    pathname[,options]...
    where options include:
    
    name
    
    The Volume name used in looking up the volume within Persistit programs (see Persistit.getVolume(String)). If the name attribute is not specified, the last name in the Volume's path name sequence is used instead.
    
    readOnly
    
    Open in Read-Only mode. (Incompatible with create mode.)
    
    create
    
    Creates the volume if it does not exist. Requires pageSize, initialPagesM, extensionPages and maximumPages to be specified.
    
    createOnly
    
    Creates the volume, or throw a VolumeAlreadyExistsException if it already exists.
    
    temporary
    
    Creates the a new, empty volume regardless of whether an existing volume file already exists.
    
    pageSize:NNN
    
    Specifies NNN as the volume's buffer size when creating a new volume. NNN must be 1024, 2048, 4096, 8192 or 16384.
    
    initialPages:NNN
    
    NNN is the initial number of pages to be allocated when this volume is first created.
    
    extensionPages:NNN
    
    NNN is the number of pages by which to extend the volume when more pages are required.
    
    maximumPages:NNN
    
    NNN is the maximum number of pages to which this volume can extend.
    
    Parameters:
    
    specification - the specification String
    
    Throws:
    
    InvalidVolumeSpecificationException
- Method Detail
  - nameFromFile
```
public static String nameFromFile(File file)
```
  - setPageSize
```
public void setPageSize(int value)
                 throws InvalidVolumeSpecificationException
```
    Throws:
    
    InvalidVolumeSpecificationException
  - setVersion
```
public void setVersion(int value)
                throws InvalidVolumeSpecificationException
```
    Throws:
    
    InvalidVolumeSpecificationException
  - setId
```
public void setId(long value)
           throws InvalidVolumeSpecificationException
```
    Throws:
    
    InvalidVolumeSpecificationException
  - getPath
```
public String getPath()
```
  - setPath
```
public void setPath(String path)
```
  - getAbsoluteFile
```
public File getAbsoluteFile()
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  - isAliased
```
public boolean isAliased()
```
  - isCreate
```
public boolean isCreate()
```
  - setCreate
```
public void setCreate(boolean create)
```
  - isCreateOnly
```
public boolean isCreateOnly()
```
  - setCreateOnly
```
public void setCreateOnly(boolean createOnly)
```
  - getPageSize
```
public int getPageSize()
```
  - getInitialPages
```
public long getInitialPages()
```
  - getExtensionPages
```
public long getExtensionPages()
```
  - getMaximumPages
```
public long getMaximumPages()
```
  - getInitialSize
```
public long getInitialSize()
```
  - setInitialSize
```
public void setInitialSize(long initialSize)
```
  - getExtensionSize
```
public long getExtensionSize()
```
  - setExtensionSize
```
public void setExtensionSize(long extensionSize)
```
  - getMaximumSize
```
public long getMaximumSize()
```
  - setMaximumSize
```
public void setMaximumSize(long maximumSize)
```
  - getVersion
```
public int getVersion()
```
  - getId
```
public long getId()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - summary
```
public String summary()
```

Class VolumeSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VolumeSpecification

VolumeSpecification

Method Detail

nameFromFile

setPageSize

setVersion

setId

getPath

setPath

getAbsoluteFile

getName

setName

isReadOnly

setReadOnly

isAliased

isCreate

setCreate

isCreateOnly

setCreateOnly

getPageSize

getInitialPages

getExtensionPages

getMaximumPages

getInitialSize

setInitialSize

getExtensionSize

setExtensionSize

getMaximumSize

setMaximumSize

getVersion

getId

toString

equals

summary