Index (dotify.common 4.4.1-SNAPSHOT API)

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

A

AbstractResourceLocator - Class in org.daisy.dotify.common.io: Provides easy access to package resources.
AbstractResourceLocator() - Constructor for class org.daisy.dotify.common.io.AbstractResourceLocator: Creates a new abstract resource locator.
AbstractResourceLocator(String) - Constructor for class org.daisy.dotify.common.io.AbstractResourceLocator: Creates a new abstract resource locator with the specified sub-path prefix, in other words a sub-path from where all resources are resolved.
add(String, String) - Method in class org.daisy.dotify.common.xml.NamespaceContextBuilder: Adds a new namespace binding with the specified prefix and uri
addHyphenationInfo(int, int, String) - Method in class org.daisy.dotify.common.text.BreakPointHandler.Builder: Adds a non-standard hyphenation rule to apply if the hyphenation point within the specified range is chosen for hyphenation.
addSubstitutionTable(URL) - Method in class org.daisy.dotify.common.text.SimpleUCharReplacer: Adds a substitution table to this instance.
ALLOW_FORCE - org.daisy.dotify.common.splitter.StandardSplitOption: Allow force to be used.
ArrayStack<E> - Class in org.daisy.dotify.common.collection: Provides a simple unsynchronized stack based on ArrayList instead of Vector.
ArrayStack() - Constructor for class org.daisy.dotify.common.collection.ArrayStack: Constructs an empty stack with an initial capacity of ten.
ArrayStack(int) - Constructor for class org.daisy.dotify.common.collection.ArrayStack: Constructs an empty stack with the specified initial capacity.
ArrayStack(Collection<? extends E>) - Constructor for class org.daisy.dotify.common.collection.ArrayStack: Constructs a stack containing the elements of the specified collection, in the order they are returned by the collection's iterator.
assertClosed() - Method in class org.daisy.dotify.common.io.StateObject: Assert that the object has been closed
assertNotOpen() - Method in class org.daisy.dotify.common.io.StateObject: Assert that the object is not open
assertOpen() - Method in class org.daisy.dotify.common.io.StateObject: Assert that the object is open
assertUnopened() - Method in class org.daisy.dotify.common.io.StateObject: Assert that the object has never been opened
attribute(Attribute) - Method in class org.daisy.dotify.common.xml.StaxFilter
attributes(Attributes) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the attributes.

B

BrailleNotationConverter - Class in org.daisy.dotify.common.braille: Converts braille notation into Unicode braille patterns.
BrailleNotationConverter(String) - Constructor for class org.daisy.dotify.common.braille.BrailleNotationConverter: Creates a new converter with the specified braille cell separator.
BreakPoint - Class in org.daisy.dotify.common.text: A BreakPoint is a data object to keep the information about a break point result.
BreakPoint(String, String, boolean) - Constructor for class org.daisy.dotify.common.text.BreakPoint: Create a new BreakPoint.
BreakPointHandler - Class in org.daisy.dotify.common.text: Breaks a paragraph of text into rows.
BreakPointHandler(String) - Constructor for class org.daisy.dotify.common.text.BreakPointHandler: Create a new BreakPointHandler.
BreakPointHandler.Builder - Class in org.daisy.dotify.common.text: Provides a builder for break point handlers
build() - Method in class org.daisy.dotify.common.text.BreakPointHandler.Builder: Creates a new break point handler with the specified configuration.
build() - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Builds the mapper with the current configuration.
build() - Method in class org.daisy.dotify.common.text.TextFileReader.Builder: Creates a new text file reader with the current configuration
build() - Method in class org.daisy.dotify.common.xml.NamespaceContextBuilder: Creates a new namespace context with the currently configured settings
build() - Method in class org.daisy.dotify.common.xml.TransformerEnvironment.Builder: Builds a new environment using the current configuration of this builder.
build() - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Creates a new XMLInfo instance using the current state of the builder.
build(Function<? super Throwable, Y>) - Method in class org.daisy.dotify.common.xml.TransformerEnvironment.Builder: Builds a new environment with the specified type of throwable that can be thrown when using the environment.
builder() - Static method in class org.daisy.dotify.common.xml.TransformerEnvironment: Creates a new TransformerEnvironment.Builder
Builder() - Constructor for class org.daisy.dotify.common.text.ConditionalMapper.Builder: Creates a builder with no specified trigger character.
Builder() - Constructor for class org.daisy.dotify.common.xml.XMLInfo.Builder: Creates a new empty builder.
Builder(InputStream) - Constructor for class org.daisy.dotify.common.text.TextFileReader.Builder: Creates a new builder with the specified input stream
Builder(String) - Constructor for class org.daisy.dotify.common.text.BreakPointHandler.Builder: Creates a new builder with the string to break.
ByteArrayInputStreamMaker - Class in org.daisy.dotify.common.io: Provides a in-memory input stream maker.
ByteArrayInputStreamMaker(byte[]) - Constructor for class org.daisy.dotify.common.io.ByteArrayInputStreamMaker: Creates a new byte array input stream maker with the specified data.
ByteArrayStreamJuggler - Class in org.daisy.dotify.common.io: Provides an in-memory stream juggler.
ByteArrayStreamJuggler(File, File) - Constructor for class org.daisy.dotify.common.io.ByteArrayStreamJuggler: Constructs a new instance

C

CachingURIResolver - Class in org.daisy.dotify.common.xml
CachingURIResolver() - Constructor for class org.daisy.dotify.common.xml.CachingURIResolver: Creates a new uri resolver
CachingURIResolver(SAXParserFactory) - Constructor for class org.daisy.dotify.common.xml.CachingURIResolver: Creates a new uri resolver with the specified sax parser factory
CaseFilter - Class in org.daisy.dotify.common.text: Implements StringFilter to return upper or lower case characters only.
CaseFilter(CaseFilter.Mode) - Constructor for class org.daisy.dotify.common.text.CaseFilter: Create a new CaseFilter
CaseFilter.Mode - Enum in org.daisy.dotify.common.text: Filter modes
cdata(Characters) - Method in class org.daisy.dotify.common.xml.StaxFilter
characters(Characters) - Method in class org.daisy.dotify.common.xml.StaxFilter
charset(Charset) - Method in class org.daisy.dotify.common.text.TextFileReader.Builder: Sets the charset for this builder
close() - Method in class org.daisy.dotify.common.io.ByteArrayStreamJuggler
close() - Method in class org.daisy.dotify.common.io.StateObject: Close the StateObject
close() - Method in class org.daisy.dotify.common.text.TextFileReader
close() - Method in class org.daisy.dotify.common.xml.StaxFilter: Closes the stream.
CLOSED - org.daisy.dotify.common.io.StateObject.State: Indicates that the StateObject has been open, but is now closed
collapsesWith(Object) - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Returns true if this unit can collapse with the other object.
CombinationFilter - Class in org.daisy.dotify.common.text: A CombinationFilter is a StringFilter that combines several other StringFilters into one.
CombinationFilter() - Constructor for class org.daisy.dotify.common.text.CombinationFilter
comment(Comment) - Method in class org.daisy.dotify.common.xml.StaxFilter
CompoundIterable<T> - Class in org.daisy.dotify.common.collection: Provides a method to iterate over several iterables of the same type as if the items were part of the same iterable.
CompoundIterable(Iterable<? extends Iterable<T>>) - Constructor for class org.daisy.dotify.common.collection.CompoundIterable: Creates a new compound iterable
CompoundIterator<T> - Class in org.daisy.dotify.common.collection: Provides an iterator for a collection of iterables
CompoundIterator(Iterable<? extends Iterable<T>>) - Constructor for class org.daisy.dotify.common.collection.CompoundIterator: Creates a new compound iterator
ConditionalMapper - Class in org.daisy.dotify.common.text: Provides a character mapper which is activated when a specific character is encountered.
ConditionalMapper.Builder - Class in org.daisy.dotify.common.text: Creates a new mapper builder.
copy() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Creates a new copy of this object in its current state.
copy(InputStream, OutputStream) - Static method in class org.daisy.dotify.common.io.FileIO: Copies an input stream to an output stream.
copyRecursive(File, File) - Static method in class org.daisy.dotify.common.io.FileIO: Copies a folder recursively
countRemaining() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Counts the remaining characters, excluding unused breakpoints.
createEmpty() - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
createEmpty() - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Creates a new empty data source of the implementing type
createTempDir() - Static method in class org.daisy.dotify.common.io.FileIO: Creates a temp folder
createTempFile() - Static method in class org.daisy.dotify.common.io.FileIO: Creates a temp file

D

DefaultSplitResult<T extends SplitPointUnit,U extends SplitPointDataSource<T,U>> - Class in org.daisy.dotify.common.splitter: Provides a default splitter result.
DefaultSplitResult(List<T>, U) - Constructor for class org.daisy.dotify.common.splitter.DefaultSplitResult: Creates a new result.
deleteRecursive(File) - Static method in class org.daisy.dotify.common.io.FileIO: Deletes a folder recursively
detectBomEncoding(byte[]) - Static method in class org.daisy.dotify.common.xml.XMLTools: Tries to detect a Unicode encoding from the supplied data based on the presence of a BOM.
detectXmlEncoding(byte[]) - Static method in class org.daisy.dotify.common.xml.XMLTools: Detects XML encoding based on this algorithm: https://www.w3.org/TR/xml/#sec-guessing.
diff(InputStream, InputStream) - Static method in class org.daisy.dotify.common.io.FileIO: Compares the input streams binary.
dtd(DTD) - Method in class org.daisy.dotify.common.xml.StaxFilter

E

empty() - Method in class org.daisy.dotify.common.collection.ArrayStack: Tests if this stack is empty.
EMPTY_MANAGER - Static variable in class org.daisy.dotify.common.splitter.SplitPointDataList: Provides an empty manager.
emptyManager() - Static method in class org.daisy.dotify.common.splitter.SplitPointDataList: Returns an empty manager
endDocument(EndDocument) - Method in class org.daisy.dotify.common.xml.StaxFilter
endElement(EndElement) - Method in class org.daisy.dotify.common.xml.StaxFilter
entityDeclaration(EntityDeclaration) - Method in class org.daisy.dotify.common.xml.StaxFilter
entityReference(EntityReference) - Method in class org.daisy.dotify.common.xml.StaxFilter
EntityResolverCache - Class in org.daisy.dotify.common.xml: Provides an entity resolver with cache
EntityResolverCache() - Constructor for class org.daisy.dotify.common.xml.EntityResolverCache: Creates a new entity resolver with cache
equals(Object) - Method in class org.daisy.dotify.common.splitter.SplitPoint
equals(Object) - Method in class org.daisy.dotify.common.text.BreakPoint
equals(Object) - Method in class org.daisy.dotify.common.text.FilterLocale

F

failed() - Method in class org.daisy.dotify.common.java.ManifestRetriever: Returns true if getManifest has been called and the manifest could not be read
FileInputStreamMaker - Class in org.daisy.dotify.common.io: Provides a file based input stream maker
FileInputStreamMaker(File) - Constructor for class org.daisy.dotify.common.io.FileInputStreamMaker: Creates a new input stream maker with the specified file as source
FileIO - Class in org.daisy.dotify.common.io: Provides file IO tools.
fill(char, int) - Static method in class org.daisy.dotify.common.text.StringTools: Fill a String with a single character
fill(String, int) - Static method in class org.daisy.dotify.common.text.StringTools: Fill a String with copies of another String
filter() - Method in class org.daisy.dotify.common.xml.StaxFilter: Applies the filter.
filter(String) - Method in class org.daisy.dotify.common.text.CaseFilter
filter(String) - Method in class org.daisy.dotify.common.text.CombinationFilter
filter(String) - Method in class org.daisy.dotify.common.text.IdentityFilter
filter(String) - Method in class org.daisy.dotify.common.text.RegexFilter: Replaces each substring of the given str that matches this objects regular expression with this objects replacement.
filter(String) - Method in interface org.daisy.dotify.common.text.StringFilter: Replaces a string with another string based on rules determined by the implementing class.
filter(String) - Method in class org.daisy.dotify.common.text.UCharFilter
FilterLocale - Class in org.daisy.dotify.common.text: Custom Locale implementation.
find(float, U, SplitOption...) - Method in class org.daisy.dotify.common.splitter.SplitPointHandler: Finds a split point at, or before, the supplied breakPoint according to the rules in the data.
find(float, U, SplitPointCost<T>, SplitOption...) - Method in class org.daisy.dotify.common.splitter.SplitPointHandler: Finds a split point at, or before, the supplied breakPoint according to the rules in the data.
findLeading(U) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Finds leading skippable units in the supplied data source.

G

get(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
get(int) - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the item at index.
get(String) - Method in interface org.daisy.dotify.common.splitter.Supplements: Gets the unit for the specified Id.
getAttributes() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the attributes attached to the element or null if the attributes has not been set.
getCost(SplitPointDataSource<T, ?>, int, int) - Method in interface org.daisy.dotify.common.splitter.SplitPointCost: Returns the cost of breaking after the unit with the specified index
getCountry() - Method in class org.daisy.dotify.common.text.FilterLocale: Gets the country of this locale
getDataSource() - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
getDataSource() - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the data source as is, typically "return this"
getDeclaredEncoding() - Method in exception org.daisy.dotify.common.xml.XmlEncodingMismatchException: Gets the encoding declared in the XML-file.
getDeclaredEncoding(String) - Static method in class org.daisy.dotify.common.xml.XMLTools: Gets the declared encoding from the given string.
getDetectedEncoding() - Method in exception org.daisy.dotify.common.xml.XmlEncodingMismatchException: Gets the encoding detected from the XML-file.
getDiscarded() - Method in class org.daisy.dotify.common.splitter.SplitPoint: Gets discarded units
getEventFactory() - Method in class org.daisy.dotify.common.xml.StaxFilter
getEventWriter() - Method in class org.daisy.dotify.common.xml.StaxFilter
getFields() - Method in class org.daisy.dotify.common.text.TextFileReader.LineData: Gets the fields
getFirstPart() - Method in class org.daisy.dotify.common.collection.SplitList: Gets the first part of the original list.
getHead() - Method in class org.daisy.dotify.common.splitter.SplitPoint: Get the head part of the SplitPointUnit list
getHead() - Method in class org.daisy.dotify.common.text.BreakPoint: Get the head part of the BreakPoint String
getInputStreamMaker() - Method in class org.daisy.dotify.common.io.ByteArrayStreamJuggler
getInputStreamMaker() - Method in interface org.daisy.dotify.common.io.StreamJuggler: Get the current input stream maker.
getLanguage() - Method in class org.daisy.dotify.common.text.FilterLocale: Gets the language of this locale
getLastUnitSize() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Gets the size of the unit if it is the last unit.
getLine() - Method in class org.daisy.dotify.common.text.TextFileReader.LineData: Gets the line as it was read.
getLineNumber() - Method in class org.daisy.dotify.common.text.TextFileReader.LineData: Gets the line number where the data was read.
getLocalName() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the local name (without prefix), or the empty string if Namespace processing is not being performed.
getManifest() - Method in class org.daisy.dotify.common.java.ManifestRetriever: Returns the jar manifest associated with this instance
getOutputStream() - Method in class org.daisy.dotify.common.io.ByteArrayStreamJuggler
getOutputStream() - Method in interface org.daisy.dotify.common.io.StreamJuggler: Get the current output stream
getOverhead() - Method in interface org.daisy.dotify.common.splitter.Supplements: Gets the overhead associated with adding at least one supplement to the result.
getPattern() - Method in class org.daisy.dotify.common.text.RegexFilter: Get this objects regular expression
getPublicId() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the public identifier of the DTD declaration or null if the public identifier has not been set or if the document doesn't contain a public identifier.
getqName() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the qualified name (with prefix), or the empty string if qualified names are not available.
getRemaining() - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
getRemaining() - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets all remaining items.
getRemaining() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Gets the remaining characters, removing unused breakpoint characters.
getReplacement() - Method in class org.daisy.dotify.common.text.RegexFilter: Get this objects replacement String
getResource(String) - Method in class org.daisy.dotify.common.io.AbstractResourceLocator
getResource(String) - Method in interface org.daisy.dotify.common.io.ResourceLocator: Gets the URL for the given resource path.
getSecondPart() - Method in class org.daisy.dotify.common.collection.SplitList: Gets the second part of the original list.
getSize(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
getSize(int) - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the size of the manager or the limit if the number of items is greater than the limit
getSupplementaryIDs() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Gets the supplementary IDs for this unit.
getSupplements() - Method in class org.daisy.dotify.common.splitter.SplitPoint: Gets the supplements.
getSupplements() - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
getSupplements() - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the split point data source supplements.
getSystemId() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the system identifier provided in the XML document or null if the system identifier has not been set or if the document doesn't contain a system identifier.
getTail() - Method in class org.daisy.dotify.common.splitter.SplitPoint: Get the tail part of the SplitPointUnit list
getTail() - Method in class org.daisy.dotify.common.text.BreakPoint: Get the tail part of the BreakPoint String
getText() - Method in class org.daisy.dotify.common.text.SplitResult: Gets the text in this result
getUnitSize() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Gets the size of the unit.
getUri() - Method in class org.daisy.dotify.common.xml.XMLInfo: Gets the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
getVariant() - Method in class org.daisy.dotify.common.text.FilterLocale: Gets the variant of this locale

H

hasElementAt(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
hasElementAt(int) - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Returns true if the manager has an element at the specified index
hashCode() - Method in class org.daisy.dotify.common.splitter.SplitPoint
hashCode() - Method in class org.daisy.dotify.common.text.BreakPoint
hashCode() - Method in class org.daisy.dotify.common.text.FilterLocale
hasNext() - Method in class org.daisy.dotify.common.collection.CompoundIterator
hasNext() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Does this BreakPointHandler has any text left to break into rows
head() - Method in class org.daisy.dotify.common.splitter.DefaultSplitResult
head() - Method in interface org.daisy.dotify.common.splitter.SplitResult: The head of the result.
head(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList: Gets the items before index.

I

IdentityFilter - Class in org.daisy.dotify.common.text: Provides an identity filter, in other words the input is returned unchanged.
IdentityFilter() - Constructor for class org.daisy.dotify.common.text.IdentityFilter
InputStreamMaker - Interface in org.daisy.dotify.common.io: Provides an interface for recreating the same input stream many times.
InterProcessLock - Class in org.daisy.dotify.common.io: Provides an inter-process locking signal that can be used to negotiate access across JVMs.
InterProcessLock(File) - Constructor for class org.daisy.dotify.common.io.InterProcessLock: Creates a new lock using the specified file.
InterProcessLock(String) - Constructor for class org.daisy.dotify.common.io.InterProcessLock: Creates a new lock with the specified id.
isA(FilterLocale) - Method in class org.daisy.dotify.common.text.FilterLocale: This locale is a subtype of the other locale
isBreakable() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Returns true if this unit is allowed to be the last unit in a result.
isClosed() - Method in class org.daisy.dotify.common.io.StateObject: Check if the StateObject has been closed
isCollapsible() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Returns true if this unit can be excluded if an adjoining object collapsesWith this unit, but has a greater size.
isEmpty() - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
isEmpty() - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Returns true if the manager contains no items.
isHardBreak() - Method in class org.daisy.dotify.common.splitter.SplitPoint: Test if this SplitPoint was achieved by breaking on a unit other than a breakpoint.
isHardBreak() - Method in class org.daisy.dotify.common.text.BreakPoint: Test if this BreakPoint was achieved by breaking on a character other than a valid break point character (typically hyphen, soft hyphen or space).
isMatch() - Method in class org.daisy.dotify.common.text.SplitResult: Returns true if this sub sequence matched the regular expression used when creating this SplitResult
isOpen() - Method in class org.daisy.dotify.common.io.StateObject: Check if the StateObject has been opened
isSkippable() - Method in interface org.daisy.dotify.common.splitter.SplitPointUnit: Returns true if this unit is skippable if it overflows the result.
isWellformedXML(File) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns true if the specified file is well formed XML.
isWellformedXML(URI) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns true if the contents at the specified URI is well formed XML.
isWellformedXML(InputSource) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns true if the specified source is well formed XML.
iterator() - Method in class org.daisy.dotify.common.collection.CompoundIterable

L

length(String) - Static method in class org.daisy.dotify.common.text.StringTools: Count the number of code points in a String.
limit(int) - Method in class org.daisy.dotify.common.text.TextFileReader.Builder: Sets the maximum number of times that the specified regular expression is matched on a single row
listFilesRecursive(File, String) - Static method in class org.daisy.dotify.common.io.FileIO: Lists files in the specified folder and sub folders having the specified extension.
localName(String) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the local name.
lock() - Method in class org.daisy.dotify.common.io.InterProcessLock: Acquire the lock.
LockException - Exception in org.daisy.dotify.common.io: Provides an exception for situations where locking fails.
LockException() - Constructor for exception org.daisy.dotify.common.io.LockException: Constructs a new exception with null as its detail message.
LockException(String) - Constructor for exception org.daisy.dotify.common.io.LockException: Constructs a new exception with the specified detail message.
LockException(String, Throwable) - Constructor for exception org.daisy.dotify.common.io.LockException: Constructs a new exception with the specified detail message and cause.
LockException(String, Throwable, boolean, boolean) - Constructor for exception org.daisy.dotify.common.io.LockException: Constructs a new exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
LockException(Throwable) - Constructor for exception org.daisy.dotify.common.io.LockException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
LOWER_CASE - org.daisy.dotify.common.text.CaseFilter.Mode: Lower case mode

M

ManifestRetriever - Class in org.daisy.dotify.common.java: Retrieves a jar manifest, if available
ManifestRetriever(Class<?>) - Constructor for class org.daisy.dotify.common.java.ManifestRetriever
map(String, String) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Defines that characters found in the replace string are to be replaced by the character at the corresponding position in the with string.
mark() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Marks the current state for later use with BreakPointHandler.reset().

N

namespace(Namespace) - Method in class org.daisy.dotify.common.xml.StaxFilter
NamespaceContextBuilder - Class in org.daisy.dotify.common.xml: Provides a builder for namespace contexts making it easy to provide namespace contexts to for example xpath evaluations.
NamespaceContextBuilder() - Constructor for class org.daisy.dotify.common.xml.NamespaceContextBuilder: Creates a new instance
NamespaceContextBuilder(String) - Constructor for class org.daisy.dotify.common.xml.NamespaceContextBuilder: Creates a new instance with the specified default namespace uri
newInputStream() - Method in class org.daisy.dotify.common.io.ByteArrayInputStreamMaker
newInputStream() - Method in class org.daisy.dotify.common.io.FileInputStreamMaker
newInputStream() - Method in interface org.daisy.dotify.common.io.InputStreamMaker: Returns a new input stream for the source.
next() - Method in class org.daisy.dotify.common.collection.CompoundIterator
nextLine() - Method in class org.daisy.dotify.common.text.TextFileReader: Gets the next line in the stream.
nextRow(int, boolean) - Method in class org.daisy.dotify.common.text.BreakPointHandler: Gets the next row from this BreakPointHandler
nextRow(int, boolean, boolean) - Method in class org.daisy.dotify.common.text.BreakPointHandler: Gets the next row from this BreakPointHandler
NO_LAST_UNIT_SIZE - org.daisy.dotify.common.splitter.StandardSplitOption: Treats the last unit as a regular unit.
notationDeclaration(NotationDeclaration) - Method in class org.daisy.dotify.common.xml.StaxFilter

O

open() - Method in class org.daisy.dotify.common.io.StateObject: Open the StateObject
OPEN - org.daisy.dotify.common.io.StateObject.State: Indicates that the StateObject is open
org.daisy.dotify.common.braille - package org.daisy.dotify.common.braille: Provides common braille functionality
org.daisy.dotify.common.collection - package org.daisy.dotify.common.collection: Provides collection tools
org.daisy.dotify.common.io - package org.daisy.dotify.common.io: Provides IO tools.
org.daisy.dotify.common.java - package org.daisy.dotify.common.java
org.daisy.dotify.common.splitter - package org.daisy.dotify.common.splitter: Provides a generalized way to split up a sequence of units, for example lines of text into pages.
org.daisy.dotify.common.text - package org.daisy.dotify.common.text: Provides tools for text processing.
org.daisy.dotify.common.xml - package org.daisy.dotify.common.xml: Provides XML tools.

P

parameters(Map<String, Object>) - Method in class org.daisy.dotify.common.xml.TransformerEnvironment.Builder: Sets the xslt parameters for this environment.
parse(String) - Static method in class org.daisy.dotify.common.text.FilterLocale: Parses the string into a locale
parseBrailleNotation(String) - Method in class org.daisy.dotify.common.braille.BrailleNotationConverter: Parses a string for braille notation and converts it to Unicode braille patterns
parseXML(File) - Static method in class org.daisy.dotify.common.xml.XMLTools: Asserts that the specified file is well formed and returns some root node information.
parseXML(File, boolean) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns some root node information and optionally asserts that the specified file is well formed.
parseXML(URI) - Static method in class org.daisy.dotify.common.xml.XMLTools: Asserts that the contents at the specified URI is well formed and returns some root node information.
parseXML(URI, boolean) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns some root node information and optionally asserts that the contents at the specified URI is well formed.
parseXML(InputSource) - Static method in class org.daisy.dotify.common.xml.XMLTools: Asserts that the source is well formed and returns some root node information.
parseXML(InputSource, boolean) - Static method in class org.daisy.dotify.common.xml.XMLTools: Returns some root node information and optionally asserts that the contents at the specified source is well formed.
peek() - Method in class org.daisy.dotify.common.collection.ArrayStack: Looks at the object at the top of this stack without removing it from the stack.
pop() - Method in class org.daisy.dotify.common.collection.ArrayStack: Removes the object at the top of this stack and returns that object as the value of this function.
processingInstruction(ProcessingInstruction) - Method in class org.daisy.dotify.common.xml.StaxFilter
publicId(String) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the public identifier of the DTD declaration.
push(E) - Method in class org.daisy.dotify.common.collection.ArrayStack: Pushes an item onto the top of this stack.
put(char, String) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Defines a replacement string for the specified character.
put(int, String) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Defines a replacement string for the specified Unicode code point.
putIgnorable(char) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Adds a transparent mapping for the specified character.
putIgnorable(int) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Adds a transparent mapping for the specified Unicode code point.

Q

qName(String) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the qualified name.

R

regex(String) - Method in class org.daisy.dotify.common.text.TextFileReader.Builder: Sets the regular expression of this builder.
RegexFilter - Class in org.daisy.dotify.common.text: Implements StringFilter using a regex pattern.
RegexFilter(String, String) - Constructor for class org.daisy.dotify.common.text.RegexFilter: Create a new RegexFilter.
remove() - Method in class org.daisy.dotify.common.collection.CompoundIterator
replace(String) - Method in class org.daisy.dotify.common.text.ConditionalMapper: Replaces characters in the input according to the rules of this mapper.
replace(String) - Method in class org.daisy.dotify.common.text.SimpleUCharReplacer: Replaces characters in the input according to this object's current configuration.
reset() - Method in class org.daisy.dotify.common.io.ByteArrayStreamJuggler
reset() - Method in interface org.daisy.dotify.common.io.StreamJuggler: Resets the input and output stream so that the input contains the written result and the output is cleared.
reset() - Method in class org.daisy.dotify.common.text.BreakPointHandler: Resets the state to the last call to BreakPointHandler.mark(), or the initial state, if no call to mark has been made.
resolve(String, String) - Method in class org.daisy.dotify.common.xml.CachingURIResolver
resolveEntity(String, String) - Method in class org.daisy.dotify.common.xml.EntityResolverCache
resolveEntity(String, String, String, String) - Method in class org.daisy.dotify.common.xml.XMLResolverAdapter
ResourceLocator - Interface in org.daisy.dotify.common.io: Provides a method for locating resources.
ResourceLocatorException - Exception in org.daisy.dotify.common.io: A ResourceLocatorException is an exception that indicates conditions in a ResourceLocator that a reasonable application might want to catch.
ResourceLocatorException() - Constructor for exception org.daisy.dotify.common.io.ResourceLocatorException: Constructs a new exception with null as its detail message.
ResourceLocatorException(String) - Constructor for exception org.daisy.dotify.common.io.ResourceLocatorException: Constructs a new exception with the specified detail message.
ResourceLocatorException(String, Throwable) - Constructor for exception org.daisy.dotify.common.io.ResourceLocatorException: Constructs a new exception with the specified detail message and cause.
ResourceLocatorException(Throwable) - Constructor for exception org.daisy.dotify.common.io.ResourceLocatorException: Constructs a new exception with the specified cause
RETAIN_TRAILING - org.daisy.dotify.common.splitter.StandardSplitOption: Retain trailing skippable units

S

search(Object) - Method in class org.daisy.dotify.common.collection.ArrayStack: Returns the 1-based position where an object is on this stack.
SimpleUCharReplacer - Class in org.daisy.dotify.common.text: Provides substitution for unicode characters with replacement strings.
SimpleUCharReplacer() - Constructor for class org.daisy.dotify.common.text.SimpleUCharReplacer: Creates a new instance.
skipLeading(U, int) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Skips leading units in the supplied list.
space(Characters) - Method in class org.daisy.dotify.common.xml.StaxFilter
split(float, List<T>, SplitOption...) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data at, or before, the supplied breakPoint according to the rules in the data.
split(float, List<T>, SplitPointCost<T>, SplitOption...) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data at, or before, the supplied breakPoint according to the rules in the data.
split(float, T...) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data at, or before, the supplied breakPoint according to the rules in the data.
split(float, U, SplitOption...) - Method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data at, or before, the supplied breakPoint according to the rules in the data.
split(float, U, SplitPointCost<T>, SplitOption...) - Method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data at, or before, the supplied breakPoint according to the rules in the data.
split(int) - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the result of splitting at the specified index.
split(CharSequence) - Method in class org.daisy.dotify.common.text.StringSplitter: Split the input string using the regular expression.
split(CharSequence, String) - Static method in class org.daisy.dotify.common.text.StringSplitter: Split the input string using the regular expression.
split(CharSequence, Pattern) - Static method in class org.daisy.dotify.common.text.StringSplitter: Split the input string using the regular expression.
split(List<T>, int) - Static method in class org.daisy.dotify.common.collection.SplitList: Splits the list into two parts at the specified position.
split(SplitPointSpecification, U) - Method in class org.daisy.dotify.common.splitter.SplitPointHandler: Splits the data according to the supplied specification.
splitInRange(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList
splitInRange(int) - Method in interface org.daisy.dotify.common.splitter.SplitPointDataSource: Gets the result of splitting at the specified index.
SplitList<T> - Class in org.daisy.dotify.common.collection: Provides a way to split a list into two parts around a given position.
SplitList(List<T>, List<T>) - Constructor for class org.daisy.dotify.common.collection.SplitList: Creates a new split list
SplitOption - Interface in org.daisy.dotify.common.splitter: An object that configures how a split is performed.
SplitPoint<T extends SplitPointUnit,U extends SplitPointDataSource<T,U>> - Class in org.daisy.dotify.common.splitter: Provides a data object to keep the information about a split point result.
SplitPoint(List<T>, List<T>, U, List<T>, boolean) - Constructor for class org.daisy.dotify.common.splitter.SplitPoint: Create a new SplitPoint.
SplitPointCost<T extends SplitPointUnit> - Interface in org.daisy.dotify.common.splitter: Provides a cost function for a split point.
SplitPointDataList<T extends SplitPointUnit> - Class in org.daisy.dotify.common.splitter: Provides split point data
SplitPointDataList() - Constructor for class org.daisy.dotify.common.splitter.SplitPointDataList: Creates a new instance with no units
SplitPointDataList(List<T>) - Constructor for class org.daisy.dotify.common.splitter.SplitPointDataList: Creates a new instance with the specified units
SplitPointDataList(List<T>, Supplements<T>) - Constructor for class org.daisy.dotify.common.splitter.SplitPointDataList: Creates a new instance with the specified units and supplements
SplitPointDataList(T...) - Constructor for class org.daisy.dotify.common.splitter.SplitPointDataList: Creates a new instance with the specified units
SplitPointDataSource<T extends SplitPointUnit,U extends SplitPointDataSource<T,U>> - Interface in org.daisy.dotify.common.splitter: Provides split point data source.
SplitPointHandler<T extends SplitPointUnit,U extends SplitPointDataSource<T,U>> - Class in org.daisy.dotify.common.splitter: Breaks units into results.
SplitPointHandler() - Constructor for class org.daisy.dotify.common.splitter.SplitPointHandler
SplitPointSpecification - Class in org.daisy.dotify.common.splitter: Provides a specification for a split point.
SplitPointUnit - Interface in org.daisy.dotify.common.splitter: Provides an interface for split point units.
SplitResult - Class in org.daisy.dotify.common.text: Data object returned by StringSplitter containing a sub sequence along with match status for the sub sequence.
SplitResult<T extends SplitPointUnit,U extends SplitPointDataSource<T,U>> - Interface in org.daisy.dotify.common.splitter: Provides a split result.
StandardSplitOption - Enum in org.daisy.dotify.common.splitter: Defines standard split options.
startDocument(StartDocument) - Method in class org.daisy.dotify.common.xml.StaxFilter
startElement(StartElement) - Method in class org.daisy.dotify.common.xml.StaxFilter: Callback function for start elements.
StateObject - Class in org.daisy.dotify.common.io: The StateObject is a convenience object that can be used to avoid certain programming errors.
StateObject() - Constructor for class org.daisy.dotify.common.io.StateObject: Create a new StateObject with the default type, which is "Object"
StateObject(String) - Constructor for class org.daisy.dotify.common.io.StateObject: Create a new StateObject with the specified type.
StateObject.State - Enum in org.daisy.dotify.common.io: Possible states for a StateObject
StaxFilter - Class in org.daisy.dotify.common.xml: Creates an XML filter using StAX.
StaxFilter(XMLEventReader, OutputStream) - Constructor for class org.daisy.dotify.common.xml.StaxFilter
StaxFilter(XMLEventReader, XMLEventFactory, OutputStream) - Constructor for class org.daisy.dotify.common.xml.StaxFilter
StaxFilter(XMLEventReader, XMLEventFactory, XMLOutputFactory, OutputStream) - Constructor for class org.daisy.dotify.common.xml.StaxFilter
StaxFilter(XMLEventReader, XMLOutputFactory, OutputStream) - Constructor for class org.daisy.dotify.common.xml.StaxFilter
StreamJuggler - Interface in org.daisy.dotify.common.io: Provides a juggler for streams.
StringFilter - Interface in org.daisy.dotify.common.text: StringFilter is in interface used when replacing a string with another string.
StringSplitter - Class in org.daisy.dotify.common.text: Provides a method for splitting a CharSequence using regex where both matching and non matching sub sequences are retained.
StringSplitter(String) - Constructor for class org.daisy.dotify.common.text.StringSplitter: Create a new StringSplitter using the supplied regex.
StringTools - Class in org.daisy.dotify.common.text: StringTools is a utility class for simple static operations related to strings.
Supplements<T> - Interface in org.daisy.dotify.common.splitter: Provides an interface for getting supplementary units.
systemId(String) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the system identifier of the DTD declaration.

T

tail() - Method in class org.daisy.dotify.common.splitter.DefaultSplitResult
tail() - Method in interface org.daisy.dotify.common.splitter.SplitResult: The tail of the result.
tail(int) - Method in class org.daisy.dotify.common.splitter.SplitPointDataList: Gets a tail list.
TextFileReader - Class in org.daisy.dotify.common.text: Provides a simple tool to read text files with multiple fields on each row, such as csv-files.
TextFileReader(InputStream) - Constructor for class org.daisy.dotify.common.text.TextFileReader: Creates a new TextFileReader with the default encoding and field separator.
TextFileReader(InputStream, Charset) - Constructor for class org.daisy.dotify.common.text.TextFileReader: Creates a new TextFileReader with the default field separator.
TextFileReader(InputStream, Charset, String, int) - Constructor for class org.daisy.dotify.common.text.TextFileReader
TextFileReader.Builder - Class in org.daisy.dotify.common.text: Provides a builder for a text file reader
TextFileReader.LineData - Class in org.daisy.dotify.common.text: Provides the data about a single line
toLocale() - Method in class org.daisy.dotify.common.text.FilterLocale: Returns this filter locale as a standard java Locale object
toString() - Method in class org.daisy.dotify.common.text.FilterLocale
toURL(File[]) - Static method in class org.daisy.dotify.common.io.FileIO: Converts an array of File objects into URL's
transform(Object, Object, Object, Map<String, Object>) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
transform(Object, Object, Object, Map<String, Object>, TransformerFactory) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
transform(Object, Object, Object, TransformerEnvironment<T>) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
transform(Source, Result, Source, Map<String, Object>) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
transform(Source, Result, Source, Map<String, Object>, TransformerFactory) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
transform(Source, Result, Source, TransformerEnvironment<T>) - Static method in class org.daisy.dotify.common.xml.XMLTools: Transforms the xml with the specified parameters.
TransformerEnvironment<T extends Throwable> - Class in org.daisy.dotify.common.xml: Provides a transformer environment.
TransformerEnvironment.Builder - Class in org.daisy.dotify.common.xml: Provides a builder for a TransformerEnvironment.
transformerFactory(TransformerFactory) - Method in class org.daisy.dotify.common.xml.TransformerEnvironment.Builder: Sets the transformer factory for this environment.
translate(String, String, String) - Static method in class org.daisy.dotify.common.text.ConditionalMapper: Replaces in the input string occurrences of characters listed in the replace string with the character at the corresponding position in the with string.
trigger(char) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Sets a trigger that activates the character mapper.
trigger(int) - Method in class org.daisy.dotify.common.text.ConditionalMapper.Builder: Sets a trigger that activates the character mapper.
trimLeading(List<T>) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Trims leading skippable units in the supplied list.
trimLeading(U) - Static method in class org.daisy.dotify.common.splitter.SplitPointHandler: Trims leading skippable units in the supplied data source.

U

UCharFilter - Class in org.daisy.dotify.common.text: Implements StringFilter using UCharReplacer.
UCharFilter(URL, Locale) - Constructor for class org.daisy.dotify.common.text.UCharFilter: Create a new CharFilter
UCharFilter(Locale, URL...) - Constructor for class org.daisy.dotify.common.text.UCharFilter: Create a new CharFilter
unlock() - Method in class org.daisy.dotify.common.io.InterProcessLock: Releases a previously acquired lock.
UNOPENED - org.daisy.dotify.common.io.StateObject.State: Indicates that the StateObject has not yet been opened
UPPER_CASE - org.daisy.dotify.common.text.CaseFilter.Mode: Upper case mode
uri(String) - Method in class org.daisy.dotify.common.xml.XMLInfo.Builder: Sets the uri.

V

valueOf(String) - Static method in enum org.daisy.dotify.common.io.StateObject.State: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.common.splitter.StandardSplitOption: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.daisy.dotify.common.text.CaseFilter.Mode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.daisy.dotify.common.io.StateObject.State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.common.splitter.StandardSplitOption: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.daisy.dotify.common.text.CaseFilter.Mode: Returns an array containing the constants of this enum type, in the order they are declared.

W

withTrigger(char) - Static method in class org.daisy.dotify.common.text.ConditionalMapper: Creates a new builder with the specified trigger.
withTrigger(int) - Static method in class org.daisy.dotify.common.text.ConditionalMapper: Creates a new builder with the specified trigger.

X

XmlEncodingDetectionException - Exception in org.daisy.dotify.common.xml: Provides an exception for situations where detection of the XML encoding fails.
XmlEncodingDetectionException(String) - Constructor for exception org.daisy.dotify.common.xml.XmlEncodingDetectionException: Constructs a new exception with the specified detail message.
XmlEncodingDetectionException(String, Throwable) - Constructor for exception org.daisy.dotify.common.xml.XmlEncodingDetectionException: Constructs a new exception with the specified detail message and cause.
XmlEncodingMismatchException - Exception in org.daisy.dotify.common.xml: Provides an exception for situations where the XML file has a declared encoding which doesn't match the detected encoding.
XmlEncodingMismatchException(String, String, String) - Constructor for exception org.daisy.dotify.common.xml.XmlEncodingMismatchException: Constructs a new exception with the specified detail message.
XmlEncodingMismatchException(String, Throwable, String, String) - Constructor for exception org.daisy.dotify.common.xml.XmlEncodingMismatchException: Constructs a new exception with the specified detail message and cause.
XMLInfo - Class in org.daisy.dotify.common.xml: Provides basic information about an XML-document.
XMLInfo.Builder - Class in org.daisy.dotify.common.xml: Provides a builder for XML info.
XMLResolverAdapter - Class in org.daisy.dotify.common.xml: Provides an XMLResolver that uses a SAX EntityResolver for entity resolution.
XMLResolverAdapter(EntityResolver) - Constructor for class org.daisy.dotify.common.xml.XMLResolverAdapter: Creates a new xml resolver adapter.
XMLTools - Class in org.daisy.dotify.common.xml: Provides some xml tools.
XMLToolsException - Exception in org.daisy.dotify.common.xml: Provides an exception indicating a problem with an XML tool.
XMLToolsException() - Constructor for exception org.daisy.dotify.common.xml.XMLToolsException: Constructs a new exception with null as its detail message.
XMLToolsException(String) - Constructor for exception org.daisy.dotify.common.xml.XMLToolsException: Constructs a new exception with the specified detail message.
XMLToolsException(String, Throwable) - Constructor for exception org.daisy.dotify.common.xml.XMLToolsException: Constructs a new exception with the specified detail message and cause.
XMLToolsException(Throwable) - Constructor for exception org.daisy.dotify.common.xml.XMLToolsException: Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

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