BasicDataItem (model 3.6.0-beta3 API)

java.lang.Object
- com.emc.mongoose.api.model.item.BasicItem
- - com.emc.mongoose.api.model.item.BasicDataItem

All Implemented Interfaces:

DataItem, Item, java.io.Closeable, java.io.Externalizable, java.io.Serializable, java.lang.AutoCloseable, java.nio.channels.ByteChannel, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.SeekableByteChannel, java.nio.channels.WritableByteChannel
```
public class BasicDataItem
extends BasicItem
implements DataItem
```
Created by kurila on 09.05.14. A data item which may produce uniformly distributed non-compressible content. Uses UniformDataSource as a ring buffer. Not thread safe. Note: the ReadableByteChannel.read(java.nio.ByteBuffer) method implementation will not return 0 or -1 (endless)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`layerNum`
`protected java.util.BitSet`	`modifiedRangesMask`
`protected long`	`offset`
`protected long`	`position`
`protected long`	`size`

Fields inherited from class com.emc.mongoose.api.model.item.BasicItem
name

Fields inherited from interface com.emc.mongoose.api.model.item.DataItem
LOG2

Constructor Summary

Constructors
Constructor and Description
`BasicDataItem()`
`BasicDataItem(BasicDataItem baseDataItem, long internalOffset, long size, boolean nextLayer)`
`BasicDataItem(long offset, long size)`
`BasicDataItem(long offset, long size, int layerNum)`
`BasicDataItem(java.lang.String value)`
`BasicDataItem(java.lang.String name, long offset, long size)`
`BasicDataItem(java.lang.String name, long offset, long size, int layerNum)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`commitUpdatedRanges(java.util.BitSet[] updatingRangesMaskPair)`
`boolean`	`equals(java.lang.Object o)`
`DataInput`	`getDataInput()`
`long`	`getRangeSize(int i)`
`int`	`getUpdatedRangesCount()`
`int`	`hashCode()`
`boolean`	`isOpen()`
`boolean`	`isRangeUpdated(int rangeIdx)`
`boolean`	`isUpdated()`
`int`	`layer()`
`void`	`layer(int layerNum)`
`long`	`offset()`
`void`	`offset(long offset)`
`long`	`position()`
`BasicDataItem`	`position(long position)`
`int`	`read(java.nio.ByteBuffer dst)`
`int`	`readAndVerify(java.nio.channels.ReadableByteChannel chanSrc, java.nio.ByteBuffer buff)`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`reset()`
`void`	`setDataInput(DataInput dataInput)`
`long`	`size()`
`void`	`size(long size)`
`BasicDataItem`	`slice(long from, long partSize)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String itemPath)`
`BasicDataItem`	`truncate(long size)`
`int`	`write(java.nio.ByteBuffer src)`
`void`	`writeExternal(java.io.ObjectOutput out)`
`long`	`writeToFileChannel(java.nio.channels.FileChannel chanDst, long maxCount)`
`long`	`writeToSocketChannel(java.nio.channels.WritableByteChannel chanDst, long maxCount)`

Methods inherited from class com.emc.mongoose.api.model.item.BasicItem
getName, setName

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

Methods inherited from interface com.emc.mongoose.api.model.item.DataItem
getRangeCount, getRangeOffset

Methods inherited from interface com.emc.mongoose.api.model.item.Item
getName, setName

- Field Detail
  - layerNum
```
protected int layerNum
```
  - offset
```
protected long offset
```
  - position
```
protected long position
```
  - size
```
protected long size
```
  - modifiedRangesMask
```
protected final java.util.BitSet modifiedRangesMask
```
- Constructor Detail
  - BasicDataItem
```
public BasicDataItem()
```
  - BasicDataItem
```
public BasicDataItem(java.lang.String value)
```
  - BasicDataItem
```
public BasicDataItem(long offset,
                     long size)
```
  - BasicDataItem
```
public BasicDataItem(java.lang.String name,
                     long offset,
                     long size)
```
  - BasicDataItem
```
public BasicDataItem(long offset,
                     long size,
                     int layerNum)
```
  - BasicDataItem
```
public BasicDataItem(java.lang.String name,
                     long offset,
                     long size,
                     int layerNum)
```
  - BasicDataItem
```
public BasicDataItem(BasicDataItem baseDataItem,
                     long internalOffset,
                     long size,
                     boolean nextLayer)
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BasicItem
  - toString
```
public java.lang.String toString(java.lang.String itemPath)
```
    Specified by:
    
    toString in interface Item
    
    Overrides:
    
    toString in class BasicItem
  - getDataInput
```
public final DataInput getDataInput()
```
    Specified by:
    
    getDataInput in interface DataItem
  - setDataInput
```
public final void setDataInput(DataInput dataInput)
```
    Specified by:
    
    setDataInput in interface DataItem
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface DataItem
    
    Specified by:
    
    reset in interface Item
    
    Overrides:
    
    reset in class BasicItem
  - layer
```
public final int layer()
```
    Specified by:
    
    layer in interface DataItem
  - layer
```
public final void layer(int layerNum)
```
    Specified by:
    
    layer in interface DataItem
  - size
```
public final void size(long size)
```
    Specified by:
    
    size in interface DataItem
  - offset
```
public final long offset()
```
    Specified by:
    
    offset in interface DataItem
  - offset
```
public final void offset(long offset)
```
    Specified by:
    
    offset in interface DataItem
  - slice
```
public BasicDataItem slice(long from,
                           long partSize)
```
    Specified by:
    
    slice in interface DataItem
  - position
```
public long position()
```
    Specified by:
    
    position in interface java.nio.channels.SeekableByteChannel
  - position
```
public final BasicDataItem position(long position)
```
    Specified by:
    
    position in interface java.nio.channels.SeekableByteChannel
  - size
```
public long size()
```
    Specified by:
    
    size in interface java.nio.channels.SeekableByteChannel
  - truncate
```
public BasicDataItem truncate(long size)
```
    Specified by:
    
    truncate in interface java.nio.channels.SeekableByteChannel
  - getRangeSize
```
public final long getRangeSize(int i)
```
    Specified by:
    
    getRangeSize in interface DataItem
  - isUpdated
```
public final boolean isUpdated()
```
    Specified by:
    
    isUpdated in interface DataItem
  - commitUpdatedRanges
```
public final void commitUpdatedRanges(java.util.BitSet[] updatingRangesMaskPair)
```
    Specified by:
    
    commitUpdatedRanges in interface DataItem
  - isRangeUpdated
```
public final boolean isRangeUpdated(int rangeIdx)
```
    Specified by:
    
    isRangeUpdated in interface DataItem
  - getUpdatedRangesCount
```
public final int getUpdatedRangesCount()
```
    Specified by:
    
    getUpdatedRangesCount in interface DataItem
  - close
```
public final void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.nio.channels.Channel
  - isOpen
```
public final boolean isOpen()
```
    Specified by:
    
    isOpen in interface java.nio.channels.Channel
  - read
```
public final int read(java.nio.ByteBuffer dst)
```
    Specified by:
    
    read in interface java.nio.channels.ReadableByteChannel
    
    Specified by:
    
    read in interface java.nio.channels.SeekableByteChannel
  - write
```
public final int write(java.nio.ByteBuffer src)
                throws DataCorruptionException,
                       DataSizeException
```
    Specified by:
    
    write in interface java.nio.channels.SeekableByteChannel
    
    Specified by:
    
    write in interface java.nio.channels.WritableByteChannel
    
    Throws:
    
    DataCorruptionException
    
    DataSizeException
  - writeToSocketChannel
```
public final long writeToSocketChannel(java.nio.channels.WritableByteChannel chanDst,
                                       long maxCount)
                                throws java.io.IOException
```
    Specified by:
    
    writeToSocketChannel in interface DataItem
    
    Returns:
    
    The number of bytes written, possibly zero
    
    Throws:
    
    java.nio.channels.ClosedChannelException - If this channel is closed
    
    java.nio.channels.AsynchronousCloseException - If another thread closes this channel while the write operation is in progress
    
    java.nio.channels.ClosedByInterruptException - If another thread interrupts the current thread while the write operation is in progress, thereby closing the channel and setting the current thread's interrupt status
    
    java.io.IOException - If some other I/O error occurs
  - writeToFileChannel
```
public final long writeToFileChannel(java.nio.channels.FileChannel chanDst,
                                     long maxCount)
                              throws java.io.IOException
```
    Specified by:
    
    writeToFileChannel in interface DataItem
    
    Throws:
    
    java.io.IOException
  - readAndVerify
```
public final int readAndVerify(java.nio.channels.ReadableByteChannel chanSrc,
                               java.nio.ByteBuffer buff)
                        throws DataCorruptionException,
                               java.io.IOException
```
    Specified by:
    
    readAndVerify in interface DataItem
    
    Throws:
    
    DataCorruptionException
    
    java.io.IOException
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class BasicItem
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class BasicItem
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Overrides:
    
    writeExternal in class BasicItem
    
    Throws:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Overrides:
    
    readExternal in class BasicItem
    
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException

Class BasicDataItem

Field Summary

Fields inherited from class com.emc.mongoose.api.model.item.BasicItem

Fields inherited from interface com.emc.mongoose.api.model.item.DataItem

Constructor Summary

Method Summary

Methods inherited from class com.emc.mongoose.api.model.item.BasicItem

Methods inherited from class java.lang.Object

Methods inherited from interface com.emc.mongoose.api.model.item.DataItem

Methods inherited from interface com.emc.mongoose.api.model.item.Item

Field Detail

layerNum

offset

position

size

modifiedRangesMask

Constructor Detail

BasicDataItem

BasicDataItem

BasicDataItem

BasicDataItem

BasicDataItem

BasicDataItem

BasicDataItem

Method Detail

toString

toString

getDataInput

setDataInput

reset

layer

layer

size

offset

offset

slice

position

position

size

truncate

getRangeSize

isUpdated

commitUpdatedRanges

isRangeUpdated

getUpdatedRangesCount

close

isOpen

read

write

writeToSocketChannel

writeToFileChannel

readAndVerify

equals

hashCode

writeExternal

readExternal