A B C D E F H I L M N O P R S T V W 
All Classes All Packages

A

addSubChunk(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Add a subchunk.

B

build() - Method in class com.io7m.jspiel.api.RiffChunkID.Builder
Builds a new RiffChunkID.
build() - Method in interface com.io7m.jspiel.api.RiffFileBuilderType
Build a file description using all of the information provided so far.
build() - Method in class com.io7m.jspiel.api.RiffSize.Builder
Builds a new RiffSize.
builder() - Static method in class com.io7m.jspiel.api.RiffChunkID
Creates a builder for RiffChunkID.
builder() - Static method in class com.io7m.jspiel.api.RiffSize
Creates a builder for RiffSize.
byteOrder() - Method in interface com.io7m.jspiel.api.RiffFileType
 
byteOrder() - Method in interface com.io7m.jspiel.api.RiffFileWriterDescriptionType
 

C

checkPreconditions() - Method in interface com.io7m.jspiel.api.RiffChunkIDType
Check preconditions for the type.
checkPreconditions() - Method in interface com.io7m.jspiel.api.RiffSizeType
Check preconditions for the type.
chunks() - Method in interface com.io7m.jspiel.api.RiffFileType
 
close() - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
 
close() - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
close() - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
com.io7m.jspiel.api - module com.io7m.jspiel.api
RIFF I/O (API)
com.io7m.jspiel.api - package com.io7m.jspiel.api
RIFF I/O (API)
com.io7m.jspiel.documentation - module com.io7m.jspiel.documentation
RIFF I/O (Documentation)
com.io7m.jspiel.documentation - package com.io7m.jspiel.documentation
RIFF I/O (Documentation)
com.io7m.jspiel.vanilla - module com.io7m.jspiel.vanilla
RIFF I/O (Vanilla implementation)
com.io7m.jspiel.vanilla - package com.io7m.jspiel.vanilla
RIFF I/O (Vanilla implementation)
copyOf(RiffChunkIDType) - Static method in class com.io7m.jspiel.api.RiffChunkID
Creates an immutable copy of a RiffChunkIDType value.
copyOf(RiffSizeType) - Static method in class com.io7m.jspiel.api.RiffSize
Creates an immutable copy of a RiffSizeType value.
create(ByteOrder) - Method in interface com.io7m.jspiel.api.RiffFileBuilderProviderType
Create a new file builder using the given byte order.
create(ByteOrder) - Method in class com.io7m.jspiel.vanilla.RiffFileBuilders
 
create(SeekableByteChannel, long, boolean) - Static method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
Create a new restricted seekable byte channel.
create(SeekableByteChannel, long, long, boolean) - Static method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
Create a new restricted seekable byte channel.
createForByteBuffer(URI, ByteBuffer) - Method in interface com.io7m.jspiel.api.RiffFileParserProviderType
Create a parser from the data in the given byte buffer.
createForByteBuffer(URI, ByteBuffer) - Method in class com.io7m.jspiel.vanilla.RiffParsers
 
createForChannel(URI, RiffFileWriterDescriptionType, SeekableByteChannel) - Method in interface com.io7m.jspiel.api.RiffFileWriterProviderType
Create a writer for the given byte channel.
createForChannel(URI, RiffFileWriterDescriptionType, SeekableByteChannel) - Method in class com.io7m.jspiel.vanilla.RiffWriters
 
createFromChannel(SeekableByteChannel, long, long) - Method in interface com.io7m.jspiel.api.RiffSeekableByteChannelsType
Create a restricted byte channel from the given existing channel.
createFromChannel(SeekableByteChannel, long, long) - Method in class com.io7m.jspiel.vanilla.RiffSeekableByteChannels
 

D

dataOffset() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
dataSizeExcludingForm() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
dataSizeIncludingForm() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
dataWriter() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
declaredSize() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
Documentation - Class in com.io7m.jspiel.documentation
Marker class for documentation.

E

equals(Object) - Method in class com.io7m.jspiel.api.RiffChunkID
This instance is equal to all instances of RiffChunkID that have equal attribute values.
equals(Object) - Method in class com.io7m.jspiel.api.RiffSize
This instance is equal to all instances of RiffSize that have equal attribute values.

F

file() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
findOptionalSubChunk(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find an optional subchunk as a direct subchunk of the current chunk.
findOptionalSubChunk(String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find an optional subchunk as a direct subchunk of the current chunk.
findOptionalSubChunks(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find optional subchunks as direct subchunks of the current chunk.
findOptionalSubChunks(String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find optional subchunks as direct subchunks of the current chunk.
findOptionalSubChunksWithForm(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find optional subchunks as direct subchunks of the current chunk.
findOptionalSubChunksWithForm(String, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find optional subchunks as direct subchunks of the current chunk.
findOptionalSubChunkWithForm(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find an optional subchunk as a direct subchunk of the current chunk.
findOptionalSubChunkWithForm(String, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find an optional subchunk as a direct subchunk of the current chunk.
findRequiredSubChunk(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find a required subchunk as a direct subchunk of the current chunk.
findRequiredSubChunk(String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find a required subchunk as a direct subchunk of the current chunk.
findRequiredSubChunks(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find required subchunks as direct subchunks of the current chunk.
findRequiredSubChunks(String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find required subchunks as direct subchunks of the current chunk.
findRequiredSubChunksWithForm(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find required subchunks as direct subchunks of the current chunk.
findRequiredSubChunksWithForm(String, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find required subchunks as direct subchunks of the current chunk.
findRequiredSubChunkWithForm(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find a required subchunk as a direct subchunk of the current chunk.
findRequiredSubChunkWithForm(String, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
Find a required subchunk as a direct subchunk of the current chunk.
form() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
formType() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
from(RiffChunkIDType) - Method in class com.io7m.jspiel.api.RiffChunkID.Builder
Fill a builder with attribute values from the provided RiffChunkIDType instance.
from(RiffSizeType) - Method in class com.io7m.jspiel.api.RiffSize.Builder
Fill a builder with attribute values from the provided RiffSizeType instance.

H

hashCode() - Method in class com.io7m.jspiel.api.RiffChunkID
Computes a hash code from attributes: value.
hashCode() - Method in class com.io7m.jspiel.api.RiffSize
Computes a hash code from attributes: size, padded.

I

id() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
isOpen() - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
isOpen() - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
isPadded() - Method in class com.io7m.jspiel.api.RiffSize
 
isPadded() - Method in interface com.io7m.jspiel.api.RiffSizeType
 

L

linearizedChunks() - Method in interface com.io7m.jspiel.api.RiffFileWriterDescriptionType
 
linearizedDescendantChunks() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
linearizedDescendantChunks() - Method in interface com.io7m.jspiel.api.RiffFileType
 

M

matches(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkType
 
matches(String) - Method in interface com.io7m.jspiel.api.RiffChunkType
 
matchesWithForm(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
 
matchesWithForm(String, String) - Method in interface com.io7m.jspiel.api.RiffChunkType
 

N

name() - Method in interface com.io7m.jspiel.api.RiffChunkType
 

O

of(long, boolean) - Static method in class com.io7m.jspiel.api.RiffSize
Construct a new immutable RiffSize instance.
of(String) - Static method in class com.io7m.jspiel.api.RiffChunkID
Construct a new immutable RiffChunkID instance.
ofBytes(byte[]) - Static method in class com.io7m.jspiel.api.RiffChunkIDs
Construct a chunk ID.
offset() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
offset() - Method in exception com.io7m.jspiel.api.RiffParseException
 
offset() - Method in exception com.io7m.jspiel.api.RiffWriteException
 
ordinal() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
Retrieve the ordinal number of the chunk.

P

padIfNecessary(long) - Static method in class com.io7m.jspiel.api.RiffSizes
Create a size from the given value.
parent() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
parent() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 
parse() - Method in interface com.io7m.jspiel.api.RiffFileParserType
Parse as many chunks as possible.
position() - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
position() - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
position(long) - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
position(long) - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 

R

read(ByteBuffer) - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
read(ByteBuffer) - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
RiffBuilderException - Exception in com.io7m.jspiel.api
The type of exceptions thrown by the API.
RiffBuilderException(String) - Constructor for exception com.io7m.jspiel.api.RiffBuilderException
Construct an exception.
RiffBuilderException(String, Throwable) - Constructor for exception com.io7m.jspiel.api.RiffBuilderException
Construct an exception.
RiffBuilderException(Throwable) - Constructor for exception com.io7m.jspiel.api.RiffBuilderException
Construct an exception.
RiffChunkBuilderType - Interface in com.io7m.jspiel.api
A builder for RIFF chunks.
RiffChunkDataWriterType - Interface in com.io7m.jspiel.api
A data writer for a chunk.
RiffChunkID - Class in com.io7m.jspiel.api
A FourCC chunk ID.
RiffChunkID.Builder - Class in com.io7m.jspiel.api
Builds instances of type RiffChunkID.
RiffChunkIDs - Class in com.io7m.jspiel.api
Functions to construct chunk IDs.
RiffChunkIDType - Interface in com.io7m.jspiel.api
A FourCC chunk ID.
RiffChunkType - Interface in com.io7m.jspiel.api
A parsed RIFF chunk.
RiffException - Exception in com.io7m.jspiel.api
The type of exceptions thrown by the API.
RiffException(String) - Constructor for exception com.io7m.jspiel.api.RiffException
Construct an exception.
RiffException(String, Throwable) - Constructor for exception com.io7m.jspiel.api.RiffException
Construct an exception.
RiffException(Throwable) - Constructor for exception com.io7m.jspiel.api.RiffException
Construct an exception.
RiffFileBuilderProviderType - Interface in com.io7m.jspiel.api
A provider of builders for RIFF files.
RiffFileBuilders - Class in com.io7m.jspiel.vanilla
A provider of file builders.
RiffFileBuilders() - Constructor for class com.io7m.jspiel.vanilla.RiffFileBuilders
Construct a provider.
RiffFileBuilderType - Interface in com.io7m.jspiel.api
A builder for RIFF files.
RiffFileParserProviderType - Interface in com.io7m.jspiel.api
The type of parser providers.
RiffFileParserType - Interface in com.io7m.jspiel.api
The type of parsers that can parse RIFF files.
RiffFileType - Interface in com.io7m.jspiel.api
A parsed riff file.
RiffFileWriterChunkDescriptionType - Interface in com.io7m.jspiel.api
A description of a RIFF chunk to be built.
RiffFileWriterDescriptionType - Interface in com.io7m.jspiel.api
A description of a RIFF file to be built.
RiffFileWriterProviderType - Interface in com.io7m.jspiel.api
The type of writer providers.
RiffFileWriterType - Interface in com.io7m.jspiel.api
The type of writers for RIFF files.
RiffOutOfBoundsException - Exception in com.io7m.jspiel.api
An exception raised when attempting an out-of-bounds read or write.
RiffOutOfBoundsException(String) - Constructor for exception com.io7m.jspiel.api.RiffOutOfBoundsException
Construct an exception.
RiffOutOfBoundsException(String, Throwable) - Constructor for exception com.io7m.jspiel.api.RiffOutOfBoundsException
Construct an exception.
RiffOutOfBoundsException(Throwable) - Constructor for exception com.io7m.jspiel.api.RiffOutOfBoundsException
Construct an exception.
RiffParseException - Exception in com.io7m.jspiel.api
The type of exceptions thrown by parsers.
RiffParseException(String, Throwable, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffParseException
Construct an exception.
RiffParseException(String, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffParseException
Construct an exception.
RiffParseException(Throwable, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffParseException
Construct an exception.
RiffParsers - Class in com.io7m.jspiel.vanilla
RIFF parsers.
RiffParsers() - Constructor for class com.io7m.jspiel.vanilla.RiffParsers
Construct a RIFF parser provider.
RiffRelativeSeekableByteChannel - Class in com.io7m.jspiel.vanilla
A byte channel that is offset by a fixed amount.
RiffRequiredChunkMissingException - Exception in com.io7m.jspiel.api
An exception indicating that a chunk was required but missing.
RiffRequiredChunkMissingException(String) - Constructor for exception com.io7m.jspiel.api.RiffRequiredChunkMissingException
Construct an exception.
RiffRequiredChunkMissingException(String, Throwable) - Constructor for exception com.io7m.jspiel.api.RiffRequiredChunkMissingException
Construct an exception.
RiffRequiredChunkMissingException(Throwable) - Constructor for exception com.io7m.jspiel.api.RiffRequiredChunkMissingException
Construct an exception.
RiffRestrictedSeekableByteChannel - Class in com.io7m.jspiel.vanilla
A byte channel that can only access a specified range of a given underlying channel.
RiffSeekableByteChannels - Class in com.io7m.jspiel.vanilla
The default provider of seekable byte channels.
RiffSeekableByteChannels() - Constructor for class com.io7m.jspiel.vanilla.RiffSeekableByteChannels
Construct a provider.
RiffSeekableByteChannelsType - Interface in com.io7m.jspiel.api
A provider of seekable byte channels.
RiffSize - Class in com.io7m.jspiel.api
A (possibly padded) size value.
RiffSize.Builder - Class in com.io7m.jspiel.api
Builds instances of type RiffSize.
RiffSizes - Class in com.io7m.jspiel.api
Functions to manipulate sizes.
RiffSizeType - Interface in com.io7m.jspiel.api
A (possibly padded) size value.
RiffUncheckedException - Exception in com.io7m.jspiel.api
The type of unchecked exceptions thrown by the API.
RiffUncheckedException(String) - Constructor for exception com.io7m.jspiel.api.RiffUncheckedException
Construct an exception.
RiffUncheckedException(String, Throwable) - Constructor for exception com.io7m.jspiel.api.RiffUncheckedException
Construct an exception.
RiffUncheckedException(Throwable) - Constructor for exception com.io7m.jspiel.api.RiffUncheckedException
Construct an exception.
RiffWriteException - Exception in com.io7m.jspiel.api
The type of exceptions thrown by writers.
RiffWriteException(String, Throwable, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffWriteException
Construct an exception.
RiffWriteException(String, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffWriteException
Construct an exception.
RiffWriteException(Throwable, URI, long) - Constructor for exception com.io7m.jspiel.api.RiffWriteException
Construct an exception.
RiffWriters - Class in com.io7m.jspiel.vanilla
The default implementation of the RiffFileWriterProviderType interface.
RiffWriters() - Constructor for class com.io7m.jspiel.vanilla.RiffWriters
Construct a writer provider.
rootChunk() - Method in interface com.io7m.jspiel.api.RiffFileWriterDescriptionType
 

S

setDataWriter(RiffChunkDataWriterType) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the data writer for the chunk.
setForm(String) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the form of the chunk.
setForm(Optional<String>) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the form of the chunk.
setID(RiffChunkID) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the ID of the chunk.
setOrder(ByteOrder) - Method in interface com.io7m.jspiel.api.RiffFileBuilderType
Set the byte order for the file.
setPadded(boolean) - Method in class com.io7m.jspiel.api.RiffSize.Builder
Initializes the value for the padded attribute.
setRootChunk(RiffChunkID, String) - Method in interface com.io7m.jspiel.api.RiffFileBuilderType
Set the root chunk for the file.
setSize(long) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the declared size of the chunk.
setSize(long) - Method in class com.io7m.jspiel.api.RiffSize.Builder
Initializes the value for the size attribute.
setSize(OptionalLong) - Method in interface com.io7m.jspiel.api.RiffChunkBuilderType
Set the declared size of the chunk.
setValue(String) - Method in class com.io7m.jspiel.api.RiffChunkID.Builder
Initializes the value for the value attribute.
size() - Method in class com.io7m.jspiel.api.RiffSize
 
size() - Method in interface com.io7m.jspiel.api.RiffSizeType
 
size() - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
size() - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
sizeUnpadded() - Method in interface com.io7m.jspiel.api.RiffSizeType
 
source() - Method in exception com.io7m.jspiel.api.RiffParseException
 
source() - Method in exception com.io7m.jspiel.api.RiffWriteException
 
subChunks() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
subChunks() - Method in interface com.io7m.jspiel.api.RiffFileWriterChunkDescriptionType
 

T

toString() - Method in class com.io7m.jspiel.api.RiffChunkID
Prints the immutable value RiffChunkID with attribute values.
toString() - Method in class com.io7m.jspiel.api.RiffSize
Prints the immutable value RiffSize with attribute values.
totalSize() - Method in interface com.io7m.jspiel.api.RiffChunkType
 
truncate(long) - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
truncate(long) - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 

V

value() - Method in class com.io7m.jspiel.api.RiffChunkID
 
value() - Method in interface com.io7m.jspiel.api.RiffChunkIDType
 

W

withPadded(boolean) - Method in class com.io7m.jspiel.api.RiffSize
Copy the current immutable object by setting a value for the padded attribute.
withSize(long) - Method in class com.io7m.jspiel.api.RiffSize
Copy the current immutable object by setting a value for the size attribute.
withValue(String) - Method in class com.io7m.jspiel.api.RiffChunkID
Copy the current immutable object by setting a value for the value attribute.
write() - Method in interface com.io7m.jspiel.api.RiffFileWriterType
Write all data to the output file.
write(ByteBuffer) - Method in class com.io7m.jspiel.vanilla.RiffRelativeSeekableByteChannel
 
write(ByteBuffer) - Method in class com.io7m.jspiel.vanilla.RiffRestrictedSeekableByteChannel
 
write(SeekableByteChannel) - Method in interface com.io7m.jspiel.api.RiffChunkDataWriterType
Called when a client is expected to write data to the given channel.
A B C D E F H I L M N O P R S T V W 
All Classes All Packages