IceResource

java.lang.Object
- nxm.sys.lib.IOResource
- - nxm.ice.lib.IceResource

```
public class IceResource
extends nxm.sys.lib.IOResource
```
Resource for interacting with a ICE File System

Author:

Jeff Schoen

Field Summary
- Fields inherited from class nxm.sys.lib.IOResource
  DIR_INOUT, DIR_INPUT, DIR_INPUT_TRUNC, DIR_OUTPUT, DIR_OUTPUT_TRUNC, FILE, FTP, HTTP, isOpen, JAR, MFTP, NFILE, PIPE, RAM, RAMD, SOCK, typeList, UDP, UNKNOWN, URL, USER

Constructor Summary

Constructors
Constructor and Description

IceResource()

Constructors
Constructor and Description
`IceResource()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`close()` close the resource
`boolean`	`delete()` delete the resource
`boolean`	`exists()` test existence of the resource
`static int`	`free_mem(long ptr)` Frees a block memory
`long`	`getDeviceSize()` Getter for size of the array
`int`	`getNumDevs()` Getter for number of disks
`java.lang.String`	`getPath()` Getter for AUX directory
`nxm.sys.lib.Table`	`getStatFS()` Gets statistics of file system that this resource is located on.
`int`	`getStripeSize()` Stripe size getter
`long`	`getTotalLen()` Getter for total file size
`boolean`	`isFile()` Indicates if this resource is a traditional file.
`static boolean`	`load()`
`static long`	`malloc(long size)` Allocates a block of memory
`boolean`	`open()` open the resource
`static void`	`p2ps(long ptr1, int off1, int stride1, long ptr2, int off2, int stride2, int step, int bytes)`
`int`	`read(byte[] buf, int boff, int bin)` Read data from resource.
`int`	`read(long lbuf, int boff, int bin)` Read into the native pointer at boff.
`boolean`	`seek(long soff)` seek to the specified offset in file
`void`	`setExtend(long ext)` Setter for extend size.
`void`	`setLength(long len)` set length of resource in bytes
`void`	`setURL(java.lang.String str)` Sets the fully qualified URL of the resource.
`java.lang.String`	`toString()` Return a printable string containing information about this object.
`int`	`write(byte[] buf, int boff, int bin)` Write data to resource.
`int`	`write(long lbuf, int boff, int bin)` Write from native pointer at boff.

Methods inherited from class nxm.sys.lib.IOResource
avail, dirToString, getContext, getDir, getEntry, getEntryList, getInputStream, getInstance, getLength, getOutputStream, getQualifier, getStateQualifier, getType, getType, getTypeString, getTypeString, getURL, getUrlStream, isContainer, isPipe, isReady, isStream, isStreaming, lastModified, lastModifiedTime, open, read, seek, setContext, setDir, setQualifiers, setType, write

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

- Constructor Detail
  - IceResource
```
public IceResource()
```
- Method Detail
  - p2ps
```
public static void p2ps(long ptr1,
                        int off1,
                        int stride1,
                        long ptr2,
                        int off2,
                        int stride2,
                        int step,
                        int bytes)
```
  - load
```
public static boolean load()
```
  - exists
```
public boolean exists()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    test existence of the resource
    
    Overrides:
    
    exists in class nxm.sys.lib.IOResource
    
    Returns:
    
    True if successful
  - isFile
```
public boolean isFile()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Indicates if this resource is a traditional file. This method was added in NeXtMidas 2.1.0 to go along with IOResource.isPipe() (previously (getType() == FILE) was used).
    
    Overrides:
    
    isFile in class nxm.sys.lib.IOResource
    
    Returns:
    
    True if is a file
  - delete
```
public boolean delete()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    delete the resource
    
    Overrides:
    
    delete in class nxm.sys.lib.IOResource
    
    Returns:
    
    True if successful
  - setURL
```
public void setURL(java.lang.String str)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Sets the fully qualified URL of the resource.
    
    Overrides:
    
    setURL in class nxm.sys.lib.IOResource
    
    Parameters:
    
    str - The fully qualified URL of the resource.
  - setExtend
```
public void setExtend(long ext)
```
    Setter for extend size.
    
    Parameters:
    
    ext - suggested size for extension
  - setLength
```
public void setLength(long len)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    set length of resource in bytes
    
    Overrides:
    
    setLength in class nxm.sys.lib.IOResource
    
    Parameters:
    
    len - Length in bytes
  - open
```
public boolean open()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    open the resource
    
    Overrides:
    
    open in class nxm.sys.lib.IOResource
    
    Returns:
    
    True if successful
  - close
```
public boolean close()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    close the resource
    
    Overrides:
    
    close in class nxm.sys.lib.IOResource
    
    Returns:
    
    True if successful
  - read
```
public int read(byte[] buf,
                int boff,
                int bin)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Read data from resource.
    
    Overrides:
    
    read in class nxm.sys.lib.IOResource
    
    Parameters:
    
    buf - The byte buffer to read into.
    
    boff - The byte offset into the byte array to start writing at.
    
    bin - The number of bytes to try to read.
    
    Returns:
    
    The number of bytes read (may be less than bytes when at end-of-file or no more data is available), -1 at the end of the file (EOF), or -3 (CoreIO.ERROR) on error.
  - read
```
public int read(long lbuf,
                int boff,
                int bin)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Read into the native pointer at boff.
    
    Overrides:
    
    read in class nxm.sys.lib.IOResource
    
    Parameters:
    
    lbuf - Native pointer to buffer.
    
    boff - The offset into buf to start at.
    
    bin - The number of bytes to try reading.
    
    Returns:
    
    Number of bytes actually read in (may be less than bytes when at end-of-file or no more data is available) or a value <0 if the end of the file has been reached or on error: -1 at the end of the file (EOF), or -3 (CoreIO.ERROR) on error.
    
    See Also:
    
    IOResource.read(byte[], int, int)
  - write
```
public int write(long lbuf,
                 int boff,
                 int bin)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Write from native pointer at boff.
    
    Overrides:
    
    write in class nxm.sys.lib.IOResource
    
    Parameters:
    
    lbuf - Native pointer to buffer.
    
    boff - The offset into buf to start at.
    
    bin - The number of bytes to write out.
    
    Returns:
    
    Number of bytes actually written. (In practice this is almost always equal to bytes.)
  - write
```
public int write(byte[] buf,
                 int boff,
                 int bin)
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Write data to resource.
    
    Overrides:
    
    write in class nxm.sys.lib.IOResource
    
    Parameters:
    
    buf - The byte buffer to write from.
    
    boff - The byte offset into the byte array to start writing from.
    
    bin - The number of bytes to try to write.
    
    Returns:
    
    The number of bytes written or -1 if none could be written (possibly a read-only source).
  - seek
```
public boolean seek(long soff)
```
    seek to the specified offset in file
    
    Overrides:
    
    seek in class nxm.sys.lib.IOResource
    
    Parameters:
    
    soff - Current seek offset in bytes (0..N-1).
    
    Returns:
    
    true on success, false on failure.
  - getStatFS
```
public nxm.sys.lib.Table getStatFS()
```
    Description copied from class: nxm.sys.lib.IOResource
    
    Gets statistics of file system that this resource is located on.
    
    Overrides:
    
    getStatFS in class nxm.sys.lib.IOResource
    
    Returns:
    
    Table of file system statistics of where this resource is located if available, otherwise null.
  - toString
```
public java.lang.String toString()
```
    Return a printable string containing information about this object.
    
    Overrides:
    
    toString in class java.lang.Object
  - getDeviceSize
```
public long getDeviceSize()
```
    Getter for size of the array
    
    Returns:
    
    total array size in bytes
  - getPath
```
public java.lang.String getPath()
```
    Getter for AUX directory
    
    Returns:
    
    full path to directory of this AUX
  - getStripeSize
```
public int getStripeSize()
```
    Stripe size getter
    
    Returns:
    
    size of the stripe in bytes
  - getNumDevs
```
public int getNumDevs()
```
    Getter for number of disks
    
    Returns:
    
    number of disk in the array
  - getTotalLen
```
public long getTotalLen()
```
    Getter for total file size
    
    Returns:
    
    size of file in bytes
  - malloc
```
public static long malloc(long size)
```
    Allocates a block of memory
    
    Parameters:
    
    size - number of bytes to allocate
    
    Returns:
    
    pointer to the beginning of the allocated block of memory
  - free_mem
```
public static int free_mem(long ptr)
```
    Frees a block memory
    
    Parameters:
    
    ptr - pointer to the starting address to free
    
    Returns:
    
    0 for success

Class IceResource

Field Summary

Fields inherited from class nxm.sys.lib.IOResource

Constructor Summary

Method Summary

Methods inherited from class nxm.sys.lib.IOResource

Methods inherited from class java.lang.Object

Constructor Detail

IceResource

Method Detail

p2ps

load

exists

isFile

delete

setURL

setExtend

setLength

open

close

read

read

write

write

seek

getStatFS

toString

getDeviceSize

getPath

getStripeSize

getNumDevs

getTotalLen

malloc

free_mem