BytesLocation (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.io.location.AbstractLocation
- - org.scijava.io.location.BytesLocation

All Implemented Interfaces:

Location
```
public class BytesLocation
extends AbstractLocation
```
Location backed by a ByteBank.

Author:

Curtis Rueden, Gabriel Einsdorf

Constructor Summary

Constructors
Constructor and Description
`BytesLocation(byte[] bytes)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` which wraps the specified array.
`BytesLocation(byte[] bytes, int offset, int length)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` with the specified initial capacity and the provided data.
`BytesLocation(byte[] bytes, int offset, int length, String name)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` with the specified initial capacity and the provided data.
`BytesLocation(byte[] bytes, String name)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` which wraps the specified array.
`BytesLocation(ByteArray bytes)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` that wraps the specified `ByteArray`.
`BytesLocation(ByteArray bytes, String name)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` that wraps the specified `ByteArray`.
`BytesLocation(ByteBank bytes)` Creates a `BytesLocation` backed by the specified `ByteBank`.
`BytesLocation(ByteBank bytes, String name)` Creates a `BytesLocation` backed by the specified `ByteBank`.
`BytesLocation(int initialCapacity)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` with the specified initial capacity, but with a reported size of 0.
`BytesLocation(int initialCapacity, String name)` Creates a `BytesLocation` backed by a `ByteArrayByteBank` with the specified initial capacity, but with a reported size of 0.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`ByteBank`	`getByteBank()` Gets the backing `ByteBank`.
`String`	`getName()` Gets a (typically short) name expressing this location.
`int`	`hashCode()`

Methods inherited from class org.scijava.io.location.AbstractLocation
toString

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

Methods inherited from interface org.scijava.io.location.Location
defaultName, getURI

- Constructor Detail
  - BytesLocation
```
public BytesLocation(ByteBank bytes)
```
    Creates a BytesLocation backed by the specified ByteBank.
    
    Parameters:
    
    bytes - the ByteBank that will back this Location
  - BytesLocation
```
public BytesLocation(ByteBank bytes,
                     String name)
```
    Creates a BytesLocation backed by the specified ByteBank.
    
    Parameters:
    
    bytes - the ByteBank that will back this Location
    
    name - the name of this Location
  - BytesLocation
```
public BytesLocation(int initialCapacity)
```
    Creates a BytesLocation backed by a ByteArrayByteBank with the specified initial capacity, but with a reported size of 0. This method can be used to avoid needing to grow the underlying ByteBank.
  - BytesLocation
```
public BytesLocation(int initialCapacity,
                     String name)
```
    Creates a BytesLocation backed by a ByteArrayByteBank with the specified initial capacity, but with a reported size of 0. This method can be used to avoid needing to grow the underlying ByteBank.
    
    Parameters:
    
    name - the name of this Location
  - BytesLocation
```
public BytesLocation(ByteArray bytes)
```
    Creates a BytesLocation backed by a ByteArrayByteBank that wraps the specified ByteArray.
  - BytesLocation
```
public BytesLocation(ByteArray bytes,
                     String name)
```
    Creates a BytesLocation backed by a ByteArrayByteBank that wraps the specified ByteArray.
    
    Parameters:
    
    name - the name of this Location.
  - BytesLocation
```
public BytesLocation(byte[] bytes)
```
    Creates a BytesLocation backed by a ByteArrayByteBank which wraps the specified array.
    
    Parameters:
    
    bytes - the array to wrap
  - BytesLocation
```
public BytesLocation(byte[] bytes,
                     String name)
```
    Creates a BytesLocation backed by a ByteArrayByteBank which wraps the specified array.
    
    Parameters:
    
    bytes - the array to wrap
    
    name - the name of this Location.
  - BytesLocation
```
public BytesLocation(byte[] bytes,
                     int offset,
                     int length)
```
    Creates a BytesLocation backed by a ByteArrayByteBank with the specified initial capacity and the provided data.
    
    Parameters:
    
    bytes - the bytes to copy into the new BytesLocation
    
    offset - the offset in the bytes array to start copying from
    
    length - the number of bytes to copy, starting from the offset
  - BytesLocation
```
public BytesLocation(byte[] bytes,
                     int offset,
                     int length,
                     String name)
```
    Creates a BytesLocation backed by a ByteArrayByteBank with the specified initial capacity and the provided data.
    
    Parameters:
    
    bytes - the bytes to copy into the new BytesLocation
    
    offset - the offset in the bytes array to start copying from
    
    length - the number of bytes to copy, starting from the offset
    
    name - the name of this Location.
- Method Detail
  - getByteBank
```
public ByteBank getByteBank()
```
    Gets the backing ByteBank.
  - getName
```
public String getName()
```
    Description copied from interface: Location
    
    Gets a (typically short) name expressing this location. This string is not intended to unambiguously identify the location, but rather act as a friendly, human-readable name. The precise behavior will depend on the implementation, but as an example, a file-based location could return the name of the associated file without its full path.
    
    Returns:
    
    The name, or an empty string if no name is available.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractLocation
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractLocation

Class BytesLocation

Constructor Summary

Method Summary

Methods inherited from class org.scijava.io.location.AbstractLocation

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.io.location.Location

Constructor Detail

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

BytesLocation

Method Detail

getByteBank

getName

hashCode

equals