CheckingMappedBytes (OpenHFT/Chronicle-Bytes 1.6.0 API)

java.lang.Object
- net.openhft.chronicle.bytes.AbstractBytes<Void>
- - net.openhft.chronicle.bytes.MappedBytes
  - - net.openhft.chronicle.bytes.CheckingMappedBytes

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable, CharSequence, Bytes<Void>, BytesIn<Void>, BytesOut<Void>, BytesPrepender<Bytes<Void>>, BytesStore<Bytes<Void>,Void>, ByteStringAppender<Bytes<Void>>, RandomDataInput, RandomDataOutput<Bytes<Void>>, StreamingDataInput<Bytes<Void>>, StreamingDataOutput<Bytes<Void>>, net.openhft.chronicle.core.ReferenceCounted
```
public class CheckingMappedBytes
extends MappedBytes
```
Created by peter on 08/03/16.

Field Summary
- Fields inherited from class net.openhft.chronicle.bytes.MappedBytes
  CHECKING
- Fields inherited from class net.openhft.chronicle.bytes.AbstractBytes
  bytesStore, isPresent, readPosition, writeLimit, writePosition
- Fields inherited from interface net.openhft.chronicle.bytes.Bytes
  DEFAULT_BYTE_BUFFER_CAPACITY, MAX_CAPACITY
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString

Constructor Summary

Constructors
Constructor and Description

CheckingMappedBytes(MappedFile mappedFile)

Constructors
Constructor and Description
`CheckingMappedBytes(MappedFile mappedFile)`

Method Summary

All Methods Instance Methods Concrete Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default void`	`parse8bit(Appendable buffer, StopCharsTester stopCharsTester)` parse text with ISO-8859-1 decoding as character terminated.
`default void`	`parse8bit(Appendable buffer, StopCharTester stopCharTester)` parse text with ISO-8859-1 decoding as character terminated.
`default Boolean`	`parseBoolean(StopCharTester tester)` Return true or false, or null if it could not be detected as true or false.
`default double`	`parseDouble()` parse text as a double decimal.
`default long`	`parseLong()` parse text as a long integer.
`default long`	`parseLongDecimal()` Parse the significant digits of a decimal number.
`default void`	`parseUTF(Appendable buffer, StopCharsTester stopCharsTester)` Deprecated.
`default void`	`parseUTF(Appendable buffer, StopCharTester stopCharTester)` Deprecated.
`default String`	`parseUTF(StopCharTester stopCharTester)` Deprecated.
`default void`	`parseUtf8(Appendable buffer, StopCharsTester stopCharsTester)` parse text with UTF-8 decoding as one or two character terminated.
`default void`	`parseUtf8(Appendable buffer, StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`default String`	`parseUtf8(StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`default Reader`	`reader()` Access these bytes as an ISO-8859-1 encoded Reader
`default boolean`	`skipTo(StopCharTester tester)` Skip text until a terminating character is reached.
`protected long`	`writeOffsetPositionMoved(long adding)`
`Bytes<Void>`	`writeOrderedInt(int i)`
`Bytes<Void>`	`writeOrderedInt(long offset, int i)` Perform a non stalling write with a store barrier.
`Bytes<Void>`	`writeOrderedLong(long i)`
`Bytes<Void>`	`writeOrderedLong(long offset, long i)` Perform a non stalling write with a store barrier.
`long`	`writePosition()` The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
`Bytes<Void>`	`writePosition(long position)`
`Bytes<Void>`	`writeShort(long offset, short i)` Write a short at an offset.
`Bytes<Void>`	`writeShort(short i16)`
`Bytes<Void>`	`writeSkip(long bytesToSkip)` Skip a number of bytes by moving the readPosition.
`Bytes<Void>`	`writeSome(ByteBuffer buffer)`
`Bytes<Void>`	`writeVolatileByte(long offset, byte i8)`
`Bytes<Void>`	`writeVolatileInt(long offset, int i32)`
`Bytes<Void>`	`writeVolatileLong(long offset, long i64)`
`Bytes<Void>`	`writeVolatileShort(long offset, short i16)`

Methods inherited from class net.openhft.chronicle.bytes.MappedBytes
append8bit, appendUtf8, capacity, copy, isElastic, mappedBytes, mappedBytes, mappedBytes, mappedBytes, mappedFile, performRelease, rawCopy, readCheckOffset, realCapacity, refCount, setNewChunkListener, sharedMemory, start, withSizes, write, write8bit, writeCheckOffset, writeUtf8

Methods inherited from class net.openhft.chronicle.bytes.AbstractBytes
address, bytesStore, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, equals, equalsBytes, hashCode, isPresent, isPresent, lastDecimalPlaces, lastDecimalPlaces, move, nativeRead, nativeRead, nativeWrite, nativeWrite, peekUnsignedByte, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteOffsetPositionMoved, prewriteShort, readByte, readByte, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLimit, readLimit, readLong, readLong, readOffsetPositionMoved, readPosition, readPosition, readShort, readShort, readSkip, readUnsignedByte, readVolatileInt, readVolatileLong, release, reserve, toString, underlyingObject, write, write, write, write, writeByte, writeByte, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLimit, writeLimit, writeLong, writeLong

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

Methods inherited from interface net.openhft.chronicle.bytes.Bytes
allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, bytesForRead, copyTo, copyTo, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, ensureCapacity, expect, expect, from, fromHexString, isClear, isEmpty, isEqual, safeLimit, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, wrapForRead, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, byteCheckSum, bytesForWrite, charAt, contentEquals, empty, endsWith, equalBytes, inside, isNative, length, longCheckSum, nativePointer, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, wrap, writeMaxLong, zeroOut

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface java.lang.CharSequence
chars, codePoints

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataInput
inputStream, parseHexLong, parseUTF, parseUtf8, parseWithLength, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readEnum, readPositionRemaining, readStopBit, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readWithLength

Methods inherited from interface net.openhft.chronicle.bytes.ByteStringAppender
append, append, append, append, append, append, append, append8bit, append8bit, appendBase, appendDateMillis, appendDecimal, appendTimeMillis, writer

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, write, write, write, write, write8bit, write8bit, write8bit, writeBoolean, writeEnum, writeInt24, writePositionRemaining, writeSome, writeStopBit, writeStopBit, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUTFΔ

Methods inherited from interface net.openhft.chronicle.bytes.BytesPrepender
prepend

- Constructor Detail
  - CheckingMappedBytes
```
public CheckingMappedBytes(MappedFile mappedFile)
```
- Method Detail
  - writeOffsetPositionMoved
```
protected long writeOffsetPositionMoved(long adding)
                                 throws BufferOverflowException,
                                        net.openhft.chronicle.core.io.IORuntimeException
```
    Overrides:
    
    writeOffsetPositionMoved in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeOrderedInt
```
@NotNull
public Bytes<Void> writeOrderedInt(int i)
                                     throws BufferOverflowException,
                                            net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeOrderedInt in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeOrderedInt in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeOrderedInt
```
@NotNull
public Bytes<Void> writeOrderedInt(long offset,
                                            int i)
                                     throws BufferOverflowException,
                                            net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedInt in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeOrderedInt in class AbstractBytes<Void>
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
    
    IORuntimeException - if the underlying buffer fails to resize.
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeOrderedLong
```
@NotNull
public Bytes<Void> writeOrderedLong(long i)
                                      throws BufferOverflowException,
                                             net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeOrderedLong in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeOrderedLong in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeOrderedLong
```
@NotNull
public Bytes<Void> writeOrderedLong(long offset,
                                             long i)
                                      throws BufferOverflowException,
                                             net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedLong in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeOrderedLong in class AbstractBytes<Void>
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writePosition
```
public long writePosition()
```
    The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
    
    Overrides:
    
    writePosition in class AbstractBytes<Void>
    
    Returns:
    
    position to write to.
  - writePosition
```
public Bytes<Void> writePosition(long position)
                          throws BufferOverflowException
```
    Specified by:
    
    writePosition in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writePosition in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
  - writeShort
```
@NotNull
public Bytes<Void> writeShort(short i16)
                                throws BufferOverflowException,
                                       net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeShort in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeShort in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeShort
```
@NotNull
public Bytes<Void> writeShort(long offset,
                                       short i)
                                throws BufferOverflowException,
                                       net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: RandomDataOutput
    
    Write a short at an offset.
    
    Specified by:
    
    writeShort in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeShort in class AbstractBytes<Void>
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
    
    IORuntimeException - if the underlying buffer fails to resize.
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeSkip
```
public Bytes<Void> writeSkip(long bytesToSkip)
                      throws BufferOverflowException,
                             net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: StreamingDataOutput
    
    Skip a number of bytes by moving the readPosition. Must be less than or equal to the readLimit.
    
    Specified by:
    
    writeSkip in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeSkip in class AbstractBytes<Void>
    
    Parameters:
    
    bytesToSkip - bytes to skip.
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the offset is outside the limits of the Bytes
    
    IORuntimeException - if an error occurred trying to obtain the data.
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeSome
```
@NotNull
public Bytes<Void> writeSome(@NotNull
                                      ByteBuffer buffer)
                               throws BufferOverflowException,
                                      net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeSome in interface StreamingDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeSome in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeVolatileByte
```
public Bytes<Void> writeVolatileByte(long offset,
                                     byte i8)
                              throws BufferOverflowException,
                                     net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeVolatileByte in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeVolatileByte in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeVolatileInt
```
public Bytes<Void> writeVolatileInt(long offset,
                                    int i32)
                             throws BufferOverflowException,
                                    net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeVolatileInt in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeVolatileInt in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeVolatileLong
```
public Bytes<Void> writeVolatileLong(long offset,
                                     long i64)
                              throws BufferOverflowException,
                                     net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeVolatileLong in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeVolatileLong in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - writeVolatileShort
```
public Bytes<Void> writeVolatileShort(long offset,
                                      short i16)
                               throws BufferOverflowException,
                                      net.openhft.chronicle.core.io.IORuntimeException
```
    Specified by:
    
    writeVolatileShort in interface RandomDataOutput<Bytes<Void>>
    
    Overrides:
    
    writeVolatileShort in class AbstractBytes<Void>
    
    Throws:
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - reader
```
public Reader reader()
```
    Access these bytes as an ISO-8859-1 encoded Reader
    
    Returns:
    
    as a Reader
  - parseBoolean
```
public Boolean parseBoolean(@NotNull
                            StopCharTester tester)
```
    Return true or false, or null if it could not be detected as true or false. Case is not important
    
    false: f, false, n, no, 0
    
    true: t, true, y, yes, 1
    
    Parameters:
    
    tester - to detect the end of the text.
    
    Returns:
    
    true, false, or null if neither.
  - parseUtf8
```
@NotNull
public String parseUtf8(@NotNull
                                 StopCharTester stopCharTester)
```
    parse text with UTF-8 decoding as character terminated.
    
    Parameters:
    
    stopCharTester - to check if the end has been reached.
    
    Returns:
    
    the text as a String.
  - parseUTF
```
@Deprecated
public String parseUTF(@NotNull
                                   StopCharTester stopCharTester)
```
    Deprecated.
  - parseUtf8
```
public void parseUtf8(@NotNull
                      Appendable buffer,
                      @NotNull
                      StopCharTester stopCharTester)
```
    parse text with UTF-8 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharTester - to check if the end has been reached.
  - parseUTF
```
@Deprecated
public void parseUTF(@NotNull
                                 Appendable buffer,
                                 @NotNull
                                 StopCharTester stopCharTester)
```
    Deprecated.
  - parseUtf8
```
public void parseUtf8(@NotNull
                      Appendable buffer,
                      @NotNull
                      StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException
```
    parse text with UTF-8 decoding as one or two character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharsTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseUTF
```
@Deprecated
public void parseUTF(@NotNull
                                 Appendable buffer,
                                 @NotNull
                                 StopCharsTester stopCharsTester)
                          throws BufferUnderflowException,
                                 BufferOverflowException,
                                 net.openhft.chronicle.core.io.IORuntimeException
```
    Deprecated.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parse8bit
```
public void parse8bit(Appendable buffer,
                      @NotNull
                      StopCharTester stopCharTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException
```
    parse text with ISO-8859-1 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parse8bit
```
public void parse8bit(Appendable buffer,
                      @NotNull
                      StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException
```
    parse text with ISO-8859-1 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharsTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseLong
```
public long parseLong()
               throws BufferUnderflowException,
                      net.openhft.chronicle.core.io.IORuntimeException
```
    parse text as a long integer. The terminating character is consumed.
    
    Returns:
    
    a long.
    
    Throws:
    
    BufferUnderflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseDouble
```
public double parseDouble()
                   throws BufferUnderflowException,
                          net.openhft.chronicle.core.io.IORuntimeException
```
    parse text as a double decimal. The terminating character is consumed.
    The number of decimal places can be retrieved with lastDecimalPlaces()
    
    Returns:
    
    a double.
    
    Throws:
    
    BufferUnderflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseLongDecimal
```
public long parseLongDecimal()
                      throws BufferUnderflowException
```
    Parse the significant digits of a decimal number.
    The number of decimal places can be retrieved with lastDecimalPlaces()
    
    Returns:
    
    the significant digits
    
    Throws:
    
    BufferUnderflowException
  - skipTo
```
public boolean skipTo(@NotNull
                      StopCharTester tester)
               throws net.openhft.chronicle.core.io.IORuntimeException
```
    Skip text until a terminating character is reached.
    
    Parameters:
    
    tester - to stop at
    
    Returns:
    
    true if a terminating character was found, false if the end of the buffer was reached.
    
    Throws:
    
    net.openhft.chronicle.core.io.IORuntimeException

Class CheckingMappedBytes

Field Summary

Fields inherited from class net.openhft.chronicle.bytes.MappedBytes

Fields inherited from class net.openhft.chronicle.bytes.AbstractBytes

Fields inherited from interface net.openhft.chronicle.bytes.Bytes

Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput

Constructor Summary

Method Summary

Methods inherited from class net.openhft.chronicle.bytes.MappedBytes

Methods inherited from class net.openhft.chronicle.bytes.AbstractBytes

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.bytes.Bytes

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput

Methods inherited from interface java.lang.CharSequence

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataInput

Methods inherited from interface net.openhft.chronicle.bytes.ByteStringAppender

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput

Methods inherited from interface net.openhft.chronicle.bytes.BytesPrepender

Constructor Detail

CheckingMappedBytes

Method Detail

writeOffsetPositionMoved

writeOrderedInt

writeOrderedInt

writeOrderedLong

writeOrderedLong

writePosition

writePosition

writeShort

writeShort

writeSkip

writeSome

writeVolatileByte

writeVolatileInt

writeVolatileLong

writeVolatileShort

reader

parseBoolean

parseUtf8

parseUTF

parseUtf8

parseUTF

parseUtf8

parseUTF

parse8bit

parse8bit

parseLong

parseDouble

parseLongDecimal

skipTo