A B C D E F G H I K L M N O R S T V W

A

AbstractAnn - Class in org.schwa.dr

Abstract base class for the Ann interface.

AbstractAnn() - Constructor for class org.schwa.dr.AbstractAnn

AbstractDoc - Class in org.schwa.dr

Abstract base class for the Doc interface.

AbstractDoc() - Constructor for class org.schwa.dr.AbstractDoc

add(T) - Method in class org.schwa.dr.Store

Adds a new Ann instance to the store, setting the drIndex attribute in the process.

add(int, T) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

addAll(Collection<? extends T>) - Method in class org.schwa.dr.Store

addAll(int, Collection<? extends T>) - Method in class org.schwa.dr.Store

addAnn(RTAnnSchema) - Method in class org.schwa.dr.runtime.RTManager

addField(FieldSchema) - Method in class org.schwa.dr.AnnSchema

Adds a new FieldSchema to the list of fields on this annotation class.

addField(RTFieldSchema) - Method in class org.schwa.dr.runtime.RTAnnSchema

addSchema(AnnSchema) - Method in class org.schwa.dr.DocSchema

Adds an AnnSchema schema that this document class has annotation instances for.

addStore(StoreSchema) - Method in class org.schwa.dr.DocSchema

Adds a new StoreSchema to the list of fields on this document class.

addStore(RTStoreSchema) - Method in class org.schwa.dr.runtime.RTAnnSchema

ALLOWED_FIELD_KLASSES - Static variable in class org.schwa.dr.DocSchema

Ann - Interface in org.schwa.dr

Base interface for all annotation types.

ANNOTATION_KLASSES - Static variable in class org.schwa.dr.DocSchema

AnnSchema - Class in org.schwa.dr

Schema class for docrep annotation Ann implementations.

AnnSchema(Class<? extends Ann>, String, String) - Constructor for class org.schwa.dr.AnnSchema

annSchemas - Variable in class org.schwa.dr.DocSchema

B

build(DocSchema) - Static method in class org.schwa.dr.runtime.RTFactory

buildOrMerge(RTManager, DocSchema) - Static method in class org.schwa.dr.runtime.RTFactory

ByteSlice - Class in org.schwa.dr

A slice over bytes in the docrep Java API.

ByteSlice() - Constructor for class org.schwa.dr.ByteSlice

ByteSlice(long, long) - Constructor for class org.schwa.dr.ByteSlice

C

clear() - Method in class org.schwa.dr.Store

Removes all annotation instances from the store, setting their drIndex values to null in the process.

contains(Object) - Method in class org.schwa.dr.Store

containsAll(Collection<?>) - Method in class org.schwa.dr.Store

create(Class<? extends Ann>, String) - Static method in class org.schwa.dr.AnnSchema

create(Class<? extends Ann>, String, String) - Static method in class org.schwa.dr.AnnSchema

create(Class<T>) - Static method in class org.schwa.dr.DocSchema

create() - Static method in class org.schwa.dr.runtime.RTFactory

create(Class<T>) - Method in class org.schwa.dr.Store

Creates a new annotation instance, adds it to the store, and returns the instance.

create(Class<T>, int) - Method in class org.schwa.dr.Store

Creates n new annotation instances, adding them all to the store.

create(Field, Class<? extends Ann>, dr.Store) - Static method in class org.schwa.dr.StoreSchema

createByteSlice(Field, dr.Field) - Static method in class org.schwa.dr.FieldSchema

createPointer(Field, dr.Pointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

createPointers(Field, dr.Pointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

createPointerSlice(Field, dr.Pointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

createPrimitive(Field, dr.Field) - Static method in class org.schwa.dr.FieldSchema

createSelfPointer(Field, dr.SelfPointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

createSelfPointers(Field, dr.SelfPointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

createSelfPointerSlice(Field, dr.SelfPointer, Class<? extends Ann>) - Static method in class org.schwa.dr.FieldSchema

D

Doc - Interface in org.schwa.dr

Base interface for all docrep document classes.

DocrepException - Exception in org.schwa.dr

Base class for all docrep exceptions.

DocrepException(String) - Constructor for exception org.schwa.dr.DocrepException

DocrepException(Throwable) - Constructor for exception org.schwa.dr.DocrepException

DocSchema - Class in org.schwa.dr

Schema class for docrep annotation Doc implementations.

dr - Class in org.schwa.dr

dr is a container / namespace-emulator for housing the annotation's

dr.Ann - Annotation Type in org.schwa.dr

dr.Ann can annotate public classes of the form: Any implementation of Ann

dr.Doc - Annotation Type in org.schwa.dr

dr.Doc can annotate public classes of the form: Any implementation of Doc

dr.Field - Annotation Type in org.schwa.dr

dr.Field can annotate public member fields of the form: Any primitive: byte, char, short, int, long, float, double, boolean, String ByteSlice

dr.Pointer - Annotation Type in org.schwa.dr

dr.Pointer can annotate public member fields of the form: Slice Any object which is a implementation of Ann A List of implementation of Ann

dr.SelfPointer - Annotation Type in org.schwa.dr

dr.SelfPointer can annotate public member fields of the form: Slice Any object which is a implementation of Ann A List of implementation of Ann

dr.Store - Annotation Type in org.schwa.dr

dr.Store can annotate public member fields of the form: Store

drIndex - Variable in class org.schwa.dr.AbstractAnn

The index of this annotation instance within a Store.

drLazy - Variable in class org.schwa.dr.AbstractAnn

The lazy serialised data for this annotation instance.

drLazyNElem - Variable in class org.schwa.dr.AbstractAnn

The number of fields that are lazily stored for this annotation instance.

drRT - Variable in class org.schwa.dr.AbstractDoc

The runtime manager for this document.

E

equals(Object) - Method in class org.schwa.dr.AbstractAnn

equals(Object) - Method in class org.schwa.dr.ByteSlice

equals(Object) - Method in class org.schwa.dr.Slice

equals(Object) - Method in class org.schwa.dr.Store

F

FieldMode - Enum in org.schwa.dr

A enum defining the types of modes that an Ann field can have.

FieldSchema - Class in org.schwa.dr

Schema class for docrep fields.

fieldSchemas - Variable in class org.schwa.dr.AnnSchema

G

get(int) - Method in class org.schwa.dr.Store

getContainingStore() - Method in class org.schwa.dr.runtime.RTFieldSchema

getDef() - Method in class org.schwa.dr.runtime.RTAnnSchema

getDef() - Method in class org.schwa.dr.runtime.RTFieldSchema

getDef() - Method in class org.schwa.dr.runtime.RTStoreSchema

getDocSchema() - Method in class org.schwa.dr.runtime.RTManager

getDRIndex() - Method in class org.schwa.dr.AbstractAnn

getDRIndex() - Method in interface org.schwa.dr.Ann

If this annotation instance is stored within a Store, this method returns the index of this annotation within the store.

getDRLazy() - Method in class org.schwa.dr.AbstractAnn

getDRLazy() - Method in interface org.schwa.dr.Ann

If this annotation has lazily stored attribute data, returns the lazy data as an array of bytes ready for serialisation.

getDRLazyNElem() - Method in class org.schwa.dr.AbstractAnn

getDRLazyNElem() - Method in interface org.schwa.dr.Ann

If this annotaiton has lazily stored attribute data, returns the number of lazily stored fields.

getDRRT() - Method in class org.schwa.dr.AbstractDoc

getDRRT() - Method in interface org.schwa.dr.Doc

Returns the runtime manager for this document.

getField(int) - Method in class org.schwa.dr.AnnSchema

Returns the schema for the index'th field on this annotation class.

getField(String) - Method in class org.schwa.dr.AnnSchema

Returns the schema for the field on this annotation class whose name matches the provided name.

getField() - Method in class org.schwa.dr.FieldSchema

getField(int) - Method in class org.schwa.dr.runtime.RTAnnSchema

getField() - Method in class org.schwa.dr.StoreSchema

getFieldId() - Method in class org.schwa.dr.runtime.RTFieldSchema

getFields() - Method in class org.schwa.dr.AnnSchema

Returns a list of schema objects for all of the fields on this annotation class.

getFields() - Method in class org.schwa.dr.runtime.RTAnnSchema

getFieldValue(Ann) - Method in class org.schwa.dr.FieldSchema

getKlass() - Method in class org.schwa.dr.AnnSchema

Returns the Class object for the underlying annotation class.

getKlassId() - Method in class org.schwa.dr.runtime.RTAnnSchema

getLazyData() - Method in class org.schwa.dr.runtime.RTAnnSchema

getLazyData() - Method in class org.schwa.dr.runtime.RTStoreSchema

getLazyNElem() - Method in class org.schwa.dr.runtime.RTStoreSchema

getMode() - Method in class org.schwa.dr.FieldSchema

getMode() - Method in class org.schwa.dr.StoreSchema

getName() - Method in class org.schwa.dr.AnnSchema

Returns the name of this annotation class.

getName() - Method in class org.schwa.dr.FieldSchema

getName() - Method in class org.schwa.dr.StoreSchema

getPointedToKlass() - Method in class org.schwa.dr.FieldSchema

getSchema(Class<? extends Ann>) - Method in class org.schwa.dr.DocSchema

Returns the schema for the annotation on this document class whose Class matches the provided class.

getSchema(int) - Method in class org.schwa.dr.runtime.RTManager

getSchemas() - Method in class org.schwa.dr.DocSchema

Returns a list of schema objects for all annotation types that this document contains.

getSchemas() - Method in class org.schwa.dr.runtime.RTManager

getSerial() - Method in class org.schwa.dr.AnnSchema

Returns the serial name of this annotation class.

getSerial() - Method in class org.schwa.dr.FieldSchema

getSerial() - Method in class org.schwa.dr.runtime.RTAnnSchema

getSerial() - Method in class org.schwa.dr.runtime.RTFieldSchema

getSerial() - Method in class org.schwa.dr.runtime.RTStoreSchema

getSerial() - Method in class org.schwa.dr.StoreSchema

getStart() - Method in class org.schwa.dr.ByteSlice

getStart() - Method in class org.schwa.dr.Slice

getStop() - Method in class org.schwa.dr.ByteSlice

getStop() - Method in class org.schwa.dr.Slice

getStore(String) - Method in class org.schwa.dr.DocSchema

Returns the schema for the stores on this annotation class whose name matches the provided name.

getStore(int) - Method in class org.schwa.dr.runtime.RTAnnSchema

getStore(Doc) - Method in class org.schwa.dr.StoreSchema

getStoredKlass() - Method in class org.schwa.dr.runtime.RTStoreSchema

getStoredKlass() - Method in class org.schwa.dr.StoreSchema

getStoreId() - Method in class org.schwa.dr.runtime.RTStoreSchema

getStoreName() - Method in class org.schwa.dr.FieldSchema

getStores() - Method in class org.schwa.dr.DocSchema

Returns a list of schema objects for all of the stores on this annotation class.

getStores() - Method in class org.schwa.dr.runtime.RTAnnSchema

H

hasFields() - Method in class org.schwa.dr.AnnSchema

Returns whether or not this annotation class has any fields.

hasFields() - Method in class org.schwa.dr.runtime.RTAnnSchema

hashCode() - Method in class org.schwa.dr.ByteSlice

hashCode() - Method in class org.schwa.dr.Slice

hashCode() - Method in class org.schwa.dr.Store

hasNext() - Method in class org.schwa.dr.Reader

Returns whether or not the reader iterator has any more documents to read in from the input stream.

hasStore(String) - Method in class org.schwa.dr.DocSchema

Returns whether or not this document has a store with the provided name.

hasStores() - Method in class org.schwa.dr.DocSchema

Returns whether or not this document class has any stores.

I

IllegalAnnotationException - Exception in org.schwa.dr

Exception class to indicate that a docrep annotation has been used illegally.

IllegalAnnotationException(String) - Constructor for exception org.schwa.dr.IllegalAnnotationException

indexOf(Object) - Method in class org.schwa.dr.Store

isCollection() - Method in class org.schwa.dr.FieldSchema

isCollection() - Method in class org.schwa.dr.runtime.RTFieldSchema

isEmpty() - Method in class org.schwa.dr.Store

isLazy() - Method in class org.schwa.dr.runtime.RTAnnSchema

isLazy() - Method in class org.schwa.dr.runtime.RTFieldSchema

isLazy() - Method in class org.schwa.dr.runtime.RTStoreSchema

isPointer() - Method in class org.schwa.dr.FieldSchema

isPointer() - Method in class org.schwa.dr.runtime.RTFieldSchema

isSelfPointer() - Method in class org.schwa.dr.FieldSchema

isSelfPointer() - Method in class org.schwa.dr.runtime.RTFieldSchema

isSlice() - Method in class org.schwa.dr.FieldSchema

isSlice() - Method in class org.schwa.dr.runtime.RTFieldSchema

items - Variable in class org.schwa.dr.Store

iterator() - Method in class org.schwa.dr.Reader

Returns this same object as an Iterator to comply with the Iterable interface.

iterator() - Method in class org.schwa.dr.Store

K

klass - Variable in class org.schwa.dr.AnnSchema

L

lastIndexOf(Object) - Method in class org.schwa.dr.Store

listIterator() - Method in class org.schwa.dr.Store

listIterator(int) - Method in class org.schwa.dr.Store

M

merge(RTManager, DocSchema) - Static method in class org.schwa.dr.runtime.RTFactory

N

name - Variable in class org.schwa.dr.AnnSchema

next() - Method in class org.schwa.dr.Reader

Reads the next document from the input stream and returns it.

O

org.schwa.dr - package org.schwa.dr

org.schwa.dr.runtime - package org.schwa.dr.runtime

R

Reader<T extends Doc> - Class in org.schwa.dr

Reads in docrep documents of type T from the input stream provided in the constructor.

Reader(ByteArrayInputStream, DocSchema) - Constructor for class org.schwa.dr.Reader

Constructs a new docrep reader given the input stream and document schema.

ReaderException - Exception in org.schwa.dr

Exception class for errors that occur during reading from a docrep stream.

ReaderException(String) - Constructor for exception org.schwa.dr.ReaderException

ReaderException(Throwable) - Constructor for exception org.schwa.dr.ReaderException

remove() - Method in class org.schwa.dr.Reader

This optional method from Iterator is unsupported.

remove(int) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

remove(Object) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

removeAll(Collection<?>) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

resize(int, Doc) - Method in class org.schwa.dr.StoreSchema

retainAll(Collection<?>) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

RTAnnSchema - Class in org.schwa.dr.runtime

RTAnnSchema(int, String) - Constructor for class org.schwa.dr.runtime.RTAnnSchema

RTAnnSchema(int, String, AnnSchema) - Constructor for class org.schwa.dr.runtime.RTAnnSchema

RTFactory - Class in org.schwa.dr.runtime

RTFactory() - Constructor for class org.schwa.dr.runtime.RTFactory

RTFieldSchema - Class in org.schwa.dr.runtime

RTFieldSchema(int, String, RTStoreSchema, boolean, boolean, boolean) - Constructor for class org.schwa.dr.runtime.RTFieldSchema

RTFieldSchema(int, String, RTStoreSchema, boolean, boolean, boolean, FieldSchema) - Constructor for class org.schwa.dr.runtime.RTFieldSchema

RTManager - Class in org.schwa.dr.runtime

RTStoreSchema - Class in org.schwa.dr.runtime

RTStoreSchema(int, String, RTAnnSchema, StoreSchema) - Constructor for class org.schwa.dr.runtime.RTStoreSchema

RTStoreSchema(int, String, RTAnnSchema, byte[], int) - Constructor for class org.schwa.dr.runtime.RTStoreSchema

S

serial - Variable in class org.schwa.dr.AnnSchema

set(int, T) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

setContainingStore(RTStoreSchema) - Method in class org.schwa.dr.runtime.RTFieldSchema

setDef(AnnSchema) - Method in class org.schwa.dr.runtime.RTAnnSchema

setDef(FieldSchema) - Method in class org.schwa.dr.runtime.RTFieldSchema

setDef(StoreSchema) - Method in class org.schwa.dr.runtime.RTStoreSchema

setDocSchema(RTAnnSchema) - Method in class org.schwa.dr.runtime.RTManager

setDRIndex(Integer) - Method in class org.schwa.dr.AbstractAnn

setDRIndex(Integer) - Method in interface org.schwa.dr.Ann

Sets the index of this annotation instance within its containing store.

setDRLazy(byte[]) - Method in class org.schwa.dr.AbstractAnn

setDRLazy(byte[]) - Method in interface org.schwa.dr.Ann

Sets the lazily stored attribute data for this annotation instance.

setDRLazyNElem(int) - Method in class org.schwa.dr.AbstractAnn

setDRLazyNElem(int) - Method in interface org.schwa.dr.Ann

Sets the number of lazily stored fields for this annotation instance.

setDRRT(RTManager) - Method in class org.schwa.dr.AbstractDoc

setDRRT(RTManager) - Method in interface org.schwa.dr.Doc

Sets the runtime manager for this document.

setLazy(byte[]) - Method in class org.schwa.dr.runtime.RTAnnSchema

setLazy(byte[]) - Method in class org.schwa.dr.runtime.RTStoreSchema

setSerial(String) - Method in class org.schwa.dr.AnnSchema

Sets the serial name of this annotation class.

setSerial(String) - Method in class org.schwa.dr.FieldSchema

setSerial(String) - Method in class org.schwa.dr.StoreSchema

setStart(long) - Method in class org.schwa.dr.ByteSlice

setStart(T) - Method in class org.schwa.dr.Slice

setStop(long) - Method in class org.schwa.dr.ByteSlice

setStop(T) - Method in class org.schwa.dr.Slice

setStoredKlass(RTAnnSchema) - Method in class org.schwa.dr.runtime.RTStoreSchema

size() - Method in class org.schwa.dr.Store

size(Doc) - Method in class org.schwa.dr.StoreSchema

Slice<T extends Ann> - Class in org.schwa.dr

A slice over other Ann instances in the docrep Java API.

Slice() - Constructor for class org.schwa.dr.Slice

Slice(T, T) - Constructor for class org.schwa.dr.Slice

start - Variable in class org.schwa.dr.ByteSlice

The inclusive starting point of the slice.

start - Variable in class org.schwa.dr.Slice

The inclusive starting point of the slice.

stop - Variable in class org.schwa.dr.ByteSlice

The inclusive stopping point of the slice.

stop - Variable in class org.schwa.dr.Slice

The inclusive stopping point of the slice.

Store<T extends Ann> - Class in org.schwa.dr

Implementation of docrep stores; ordered collections of annotation instances.

Store() - Constructor for class org.schwa.dr.Store

StoreSchema - Class in org.schwa.dr

Schema class for docrep stores.

storeSchemas - Variable in class org.schwa.dr.DocSchema

subList(int, int) - Method in class org.schwa.dr.Store

This method is unsupported but required by the List interface.

T

toArray() - Method in class org.schwa.dr.Store

toArray(T[]) - Method in class org.schwa.dr.Store

V

valueOf(String) - Static method in enum org.schwa.dr.FieldMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.schwa.dr.FieldMode

Returns an array containing the constants of this enum type, in the order they are declared.

W

WIRE_VERSION - Static variable in class org.schwa.dr.Reader

docrep wire protocol version that this reader knows how to read.

WIRE_VERSION - Static variable in class org.schwa.dr.Writer

docrep wire protocol version that this writer knows how to write.

write(Doc) - Method in class org.schwa.dr.Writer

Serialises a docrep document to the wrapped output stream.

Writer - Class in org.schwa.dr

Writes out docrep documents to the output stream provided in the constructor.

Writer(OutputStream, DocSchema) - Constructor for class org.schwa.dr.Writer

Constructs a new docrep writer given the output stream and document schema.

WriterException - Exception in org.schwa.dr

Exception class for errors that occur during writing to a docrep stream.

WriterException(String) - Constructor for exception org.schwa.dr.WriterException

WriterException(Throwable) - Constructor for exception org.schwa.dr.WriterException

A B C D E F G H I K L M N O R S T V W