Index (Apache Daffodil 4.0.0 API)

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

AnyURI - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
asString() - Method in interface org.apache.daffodil.api.LocationInSchemaFile: Since we can't override toString to return locationDescription, we create a neew asString method to do the same

B

bitPos1b() - Method in interface org.apache.daffodil.api.DataLocation
Boolean - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
Byte - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
bytePos1b() - Method in interface org.apache.daffodil.api.DataLocation

C

CDATA - Enum constant in enum class org.apache.daffodil.api.infoset.XMLTextEscapeStyle: The text of xs:string elements are wrapped in CDATA tags if the string contains special characters (quotation mark, ampersand, less-than, greater-than) or whitespace
characters(char[], int, int) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
ChecksumLayer - Class in org.apache.daffodil.api.layers: A checksum layer computes a numeric value from a region of the data stream.
ChecksumLayer(String, String) - Constructor for class org.apache.daffodil.api.layers.ChecksumLayer: Base class constructor
ChoiceMetadata - Interface in org.apache.daffodil.api.metadata: Access to metadata values specific to choices
close() - Method in interface org.apache.daffodil.api.InputSourceDataInputStream: Closes the underlying resource.
CodeGenerator - Interface in org.apache.daffodil.api: Source code generation and compilation is performed with a language-specific CodeGenerator}, which must be interrogated for diagnostics to see if each call was successful or not.
columnDescription() - Method in interface org.apache.daffodil.api.LocationInSchemaFile
compileCode(Path) - Method in interface org.apache.daffodil.api.CodeGenerator: Compiles the generated code in order to run it in a TDML test
compileFile(File) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema file into a ProcessorFactory
compileFile(File, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema file into a ProcessorFactory
compileFile(File, String, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema file into a ProcessorFactory
compiler() - Static method in class org.apache.daffodil.api.Daffodil: Create a new object used to compile DFDL schemas
Compiler - Interface in org.apache.daffodil.api: Compile DFDL schemas into ProcessorFactory's or reload saved parsers into DataProcessor's.
compileResource(String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL resource name into a ProcessorFactory
compileResource(String, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL resource name into a ProcessorFactory
compileResource(String, String, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL resource name into a ProcessorFactory
compileSource(URI) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema source into a ProcessorFactory
compileSource(URI, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema source into a ProcessorFactory
compileSource(URI, String, String) - Method in interface org.apache.daffodil.api.Compiler: Compile DFDL schema source into a ProcessorFactory
ComplexElementMetadata - Interface in org.apache.daffodil.api.metadata: Access to metadata values exclusive to elements of complex type.
compute(boolean, ByteBuffer) - Method in class org.apache.daffodil.api.layers.ChecksumLayer: Override to compute the checksum of a buffer of data.
createUserDefinedFunction(String, String) - Method in class org.apache.daffodil.api.udf.UserDefinedFunctionProvider: Finds and initializes User Defined Function class based on namespace and name provided.

D

Daffodil - Class in org.apache.daffodil.api: Factory object to create a Compiler
DAFFODIL_SAX_URN_BLOBDIRECTORY - Static variable in interface org.apache.daffodil.api.DaffodilParseXMLReader: Property name to get/set blob directory as String from the DaffodilParseXMLReader
DAFFODIL_SAX_URN_BLOBPREFIX - Static variable in interface org.apache.daffodil.api.DaffodilParseXMLReader: Property name to get/set blob prefix as String from the DaffodilParseXMLReader
DAFFODIL_SAX_URN_BLOBSUFFIX - Static variable in interface org.apache.daffodil.api.DaffodilParseXMLReader: Property name to get/set blob suffix as String from the DaffodilParseXMLReader
DAFFODIL_SAX_URN_PARSERESULT - Static variable in interface org.apache.daffodil.api.DaffodilParseXMLReader: Property name to get the ParseResult from the DaffodilParseXMLReader.
Daffodil.InfosetInputterEventType - Enum Class in org.apache.daffodil.api: These are the events that a derived specific InfosetInputter creates.
DaffodilDebuggerRunner - Interface in org.apache.daffodil.api.debugger: Daffodil Debugger Runner interface to run the built-in Daffodil debugger.
DaffodilParseXMLReader - Interface in org.apache.daffodil.api: SAX Method of parsing schema and getting the DFDL Infoset via designated org.xml.sax.ContentHandler, based on the org.xml.sax.XMLReader interface
DaffodilUnhandledSAXException - Exception in org.apache.daffodil.api.exceptions: This exception is thrown when and unexpected error occurs while unparsing an infoset with an XMLReader and a DaffodilUnparseContentHandler.
DaffodilUnhandledSAXException(Exception) - Constructor for exception org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException: constructor for error cause only
DaffodilUnhandledSAXException(String) - Constructor for exception org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException: constructor for error message only
DaffodilUnhandledSAXException(String, Exception) - Constructor for exception org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException: constructor for error message and cause
DaffodilUnparseContentHandler - Interface in org.apache.daffodil.api: Accepts SAX callback events from any SAX XMLReader for unparsing
DaffodilUnparseErrorSAXException - Exception in org.apache.daffodil.api.exceptions: This exception is thrown when UnparseResult.isError returns true while unparsing an infoset with an XMLReader and a DaffodilUnparseContentHandler.
DaffodilUnparseErrorSAXException(String) - Constructor for exception org.apache.daffodil.api.exceptions.DaffodilUnparseErrorSAXException: constructor for error message only
DaffodilXMLEntityResolver - Class in org.apache.daffodil.api: Returns the EntityResolver used by Daffodil to resolve import/include schemaLocations.
DataLocation - Interface in org.apache.daffodil.api: Relevant data location for a diagnostic message.
DataProcessor - Interface in org.apache.daffodil.api: Compiled version of a DFDL Schema, used to parse data and get the DFDL infoset
Date - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
DateTime - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
Debugger - Interface in org.apache.daffodil.api.debugger: Debugger interface for receiving debug events during Daffodil processing
Decimal - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
DFDLPrimType - Enum Class in org.apache.daffodil.api: An enumeration of all DFDL's simple types.
dfdlType() - Method in interface org.apache.daffodil.api.metadata.SimpleElementMetadata: Primitive Type enum usable from Java
Diagnostic - Exception in org.apache.daffodil.api: Class containing diagnostic information.
Diagnostic(String, Throwable, boolean, boolean) - Constructor for exception org.apache.daffodil.api.Diagnostic: Constructor to create Diagnostic
diagnosticDebugName() - Method in interface org.apache.daffodil.api.metadata.Metadata: The name of the schema component, in a form suitable for diagnostic messages.
Double - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType

E

ElementMetadata - Interface in org.apache.daffodil.api.metadata: Common metadata access for all elements, of simple or complex type.
endArray(InfosetArray) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the end of an array of elements.
endChoiceMetadata(ChoiceMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for choice group definitions.
endComplex(InfosetComplexElement) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the end of a complex element.
endComplexElementMetadata(ComplexElementMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for complex type element metadata (for declarations or references)
endDocument() - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
endDocument() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the end of the infoset.
EndDocument - Enum constant in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType
endElement(String, String, String) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
EndElement - Enum constant in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType
endPrefixMapping(String) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
endSequenceMetadata(SequenceMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for sequence group definitions.
endSimple(InfosetSimpleElement) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the end of a simple element.
Experimental - Annotation Interface in org.apache.daffodil.api: Indicates that this API is experimental and may change or be removed in the future.
ExternalVariableException - Exception in org.apache.daffodil.api.exceptions: This exception will be thrown if an error occurs when setting an external variable.
ExternalVariableException(String) - Constructor for exception org.apache.daffodil.api.exceptions.ExternalVariableException: constructor for error message only

F

fileDescription() - Method in interface org.apache.daffodil.api.LocationInSchemaFile
find(String) - Static method in class org.apache.daffodil.api.validation.Validators: Attempt to find the factory
fini() - Method in interface org.apache.daffodil.api.debugger.DaffodilDebuggerRunner: Called once upon completion of a parse, allowing one to perform any steps necessary to clean up the debugger runner.
fini() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: clean up
Float - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
forLanguage(String) - Method in interface org.apache.daffodil.api.ProcessorFactory: Experimental

G

generateCode(String) - Method in interface org.apache.daffodil.api.CodeGenerator: Generates language-specific code from a DFDL schema to parse or unparse data
get(String) - Static method in class org.apache.daffodil.api.validation.Validators: Get the factory by name or throw
getBlobDirectory() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter
getBlobPaths() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Get the list of blob paths that were output in the infoset.
getBlobPrefix() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter
getBlobSuffix() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter
getBoolean() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getByte() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all integer types representable by an 8-bit signed java.lang.Byte.
getCommand() - Method in interface org.apache.daffodil.api.debugger.DaffodilDebuggerRunner: Called by Daffodil when there is a pause in parsing to determine what debugger actions should be taken.
getContentHandler() - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Retrieve registered content handler
getDataLocations() - Method in exception org.apache.daffodil.api.Diagnostic: Get data location information relevant to this diagnostic object.
getDate() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getDateTime() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getDecimal() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getDiagnostics() - Method in interface org.apache.daffodil.api.WithDiagnostics: Get the list of Diagnostic's created during the construction of the parent object
getDouble() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getDTDHandler() - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Retrieve registered DTD Handler
getEntityResolver() - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Return the registered entity resolver
getEntityResolver() - Static method in class org.apache.daffodil.api.DaffodilXMLEntityResolver
getErrorHandler() - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Retrieve registered error handler
getEventType() - Method in class org.apache.daffodil.api.infoset.InfosetInputter
getFeature(String) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Get the value of the feature flag
getFloat() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getHexBinary() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getInt() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all integer types representable by a 32 bit signed java.lang.Integer.
getInteger() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to get the value of DFDL `integer` type, which is an unbounded-magnitude integer.
getLayerRuntime() - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
getLocalName() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Get the local name of the current event.
getLocationsInSchemaFiles() - Method in exception org.apache.daffodil.api.Diagnostic: Get schema location information relevant to this diagnostic object.
getLong() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all integer types representable by a 64 bit signed java.lang.Long.
getLSResourceResolver() - Static method in class org.apache.daffodil.api.DaffodilXMLEntityResolver
getMessage() - Method in exception org.apache.daffodil.api.Diagnostic: Get the diagnostic message
getModeName() - Method in exception org.apache.daffodil.api.Diagnostic: Get the diagnostic mode name
getNamespaceURI() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Get the namespace of the current event.
getNonNegativeInteger() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getObject() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getProcessingErrorExceptions() - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
getProperty(String) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Get the value of the property
getResult() - Method in class org.apache.daffodil.api.infoset.JDOMInfosetOutputter: Get the jdom Document representing the infoset created during a parse
getResult() - Method in class org.apache.daffodil.api.infoset.ScalaXMLInfosetOutputter: Get the scala.xml.Node representing the infoset created during a parse
getResult() - Method in class org.apache.daffodil.api.infoset.W3CDOMInfosetOutputter: Get the w3c Document representing the infoset created during a parse
getShort() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all integer types representable by a 16 bit signed java.lang.Short.
getSimpleText(NodeInfo.Kind, Map<String, String>) - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Get the content of a simple type.
getString() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getSupportsNamespaces() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Get if this infoset inputter supports namespaces.
getText() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Obtains the value, then converts it to a string.
getTime() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getUnparseResult() - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler: Returns the result of the SAX unparse containing diagnostic information.
getUnsignedByte() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all non-negative integer types representable by an 8-bit unsigned integer.
getUnsignedInt() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all non-negative integer types representable by a 32-bit unsigned integer.
getUnsignedLong() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all non-negative integer types representable by a 64-bit unsigned integer.
getUnsignedShort() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement: Used to access simple element values of all non-negative integer types representable by a 16-bit unsigned integer.
getURI() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
getUserDefinedFunctionClasses() - Method in class org.apache.daffodil.api.udf.UserDefinedFunctionProvider: Must be implemented to return the classes of the User Defined Function this provider is aware of/providing
getXMLEntityResolver() - Static method in class org.apache.daffodil.api.DaffodilXMLEntityResolver

H

hasData() - Method in interface org.apache.daffodil.api.InputSourceDataInputStream: Returns true if the input stream has at least 1 bit of data.
hasNext() - Method in class org.apache.daffodil.api.infoset.InfosetInputter
HexBinary - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType

I

ignorableWhitespace(char[], int, int) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
InfosetArray - Interface in org.apache.daffodil.api.infoset: API access to array objects in the DFDL Infoset
InfosetComplexElement - Interface in org.apache.daffodil.api.infoset: Methods specific to complex elements in the infoset
InfosetDocument - Interface in org.apache.daffodil.api.infoset: Access to the infoset document element (also known as the root element).
InfosetElement - Interface in org.apache.daffodil.api.infoset: API access to elements of the DFDL Infoset of both complex and simple type.
InfosetInputter - Class in org.apache.daffodil.api.infoset: Abstract class used to determine how the infoset representation should be input from a call to DataProcessor.unparse(input* DataProcessor.unparse).
InfosetInputter() - Constructor for class org.apache.daffodil.api.infoset.InfosetInputter
InfosetItem - Interface in org.apache.daffodil.api.infoset: Methods common to all infoset items
InfosetOutputter - Class in org.apache.daffodil.api.infoset: Abstract class used to determine how the infoset representation should be output from a call to DataProcessor.parse(input:org\.apache\.daffodil* DataProcessor.parse).
InfosetOutputter() - Constructor for class org.apache.daffodil.api.infoset.InfosetOutputter
InfosetSimpleElement - Interface in org.apache.daffodil.api.infoset: Methods specific to simple elements in the infoset
InfosetTypeException - Exception in org.apache.daffodil.api.infoset: Thrown if you try to access a simple type but the value of the InfosetSimpleElement is not convertible to that type.
InfosetTypeException(String) - Constructor for exception org.apache.daffodil.api.infoset.InfosetTypeException: constructor for string only
InfosetTypeException(String, Throwable) - Constructor for exception org.apache.daffodil.api.infoset.InfosetTypeException: constructor for string and throwable
InfosetTypeException(Throwable) - Constructor for exception org.apache.daffodil.api.infoset.InfosetTypeException: constructor for sthrowable only
init(DaffodilDebugger) - Method in interface org.apache.daffodil.api.debugger.DaffodilDebuggerRunner: initialize using an Daffodil Debugger
InputSourceDataInputStream - Interface in org.apache.daffodil.api: Provides Daffodil with byte data from an InputStream, ByteBuffer, or byte Array.
Int - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
Integer - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
InvalidParserException - Exception in org.apache.daffodil.api.exceptions: This exception will be thrown as a result of attempting to reload a saved parser that is invalid (not a parser file, corrupt, etc.) or is not in the GZIP format.
InvalidParserException(String) - Constructor for exception org.apache.daffodil.api.exceptions.InvalidParserException: constructor for error message only
InvalidParserException(String, Throwable) - Constructor for exception org.apache.daffodil.api.exceptions.InvalidParserException: constructor for error message and cause
InvalidUsageException - Exception in org.apache.daffodil.api.exceptions: This exception will be thrown as a result of an invalid usage of the Daffodil API
InvalidUsageException(String) - Constructor for exception org.apache.daffodil.api.exceptions.InvalidUsageException: constructor for error message only
InvalidUsageException(String, Throwable) - Constructor for exception org.apache.daffodil.api.exceptions.InvalidUsageException: constructor for error message and cause
isArray() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
isError() - Method in exception org.apache.daffodil.api.Diagnostic: Determine if a diagnostic object represents an error or something less serious.
isError() - Method in interface org.apache.daffodil.api.WithDiagnostics: Determine if any errors occurred in the creation of the parent object.
isNillable() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
isNilled() - Method in interface org.apache.daffodil.api.infoset.InfosetElement: In DFDL both simple and complex type elements can be nilled.
isNilled() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Determine if the current event is nilled.
isOptional() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
isProcessingError() - Method in interface org.apache.daffodil.api.Result
isRegistered(String) - Static method in class org.apache.daffodil.api.validation.Validators: Check for registration of named factory
isValidation() - Method in exception org.apache.daffodil.api.Diagnostic: Determine if a diagnostic object represents a validation diagnostic.
isValidationError() - Method in interface org.apache.daffodil.api.Result

J

JDOMInfosetOutputter - Class in org.apache.daffodil.api.infoset: InfosetOutputter whose result is represented as an org.jdom2.Document
JDOMInfosetOutputter() - Constructor for class org.apache.daffodil.api.infoset.JDOMInfosetOutputter

L

Layer - Class in org.apache.daffodil.api.layers: This is the primary API class for writing layers.
Layer(String, String) - Constructor for class org.apache.daffodil.api.layers.Layer: Constructs a new Layer object with the given layer name and namespace URI.
LayerFatalException - Exception in org.apache.daffodil.api.layers.exceptions: This is used to encapsulate runtime exceptions that are thrown out of layer code.
LayerFatalException(String) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerFatalException
LayerFatalException(String, Throwable) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerFatalException
LayerFatalException(Throwable) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerFatalException: When constructed with just a cause, we also pass a message if the cause provides one because the SLF4J logging system doesn't synthesize a message from the cause if only a cause is provided.
LayerNotEnoughDataException - Exception in org.apache.daffodil.api.layers.exceptions: LayerNotEnoughDataException is a custom exception class that represents an exception that occurs when there is insufficient data for a layer in a program.
LayerNotEnoughDataException(int, int) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerNotEnoughDataException: Creates a new instance of LayerNotEnoughDataException with the specified number of needed bytes and available bytes.
LayerNotEnoughDataException(String) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerNotEnoughDataException
LayerNotEnoughDataException(String, Throwable) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerNotEnoughDataException
LayerNotEnoughDataException(Throwable) - Constructor for exception org.apache.daffodil.api.layers.exceptions.LayerNotEnoughDataException: When creating an exception with just a cause, we also synthesize some sort of message, because otherwise SLF4J doesn't do so, and you get out errors like '[error] null' because you didn't supply a message.
lineDescription() - Method in interface org.apache.daffodil.api.LocationInSchemaFile
lineOutput(String) - Method in interface org.apache.daffodil.api.debugger.DaffodilDebuggerRunner: Called by Daffodil when a debugger command has produced output.
list() - Static method in class org.apache.daffodil.api.validation.Validators: Get a list of available validator names
localName() - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
location() - Method in interface org.apache.daffodil.api.Result: Get the current DataLocation
locationDescription() - Method in interface org.apache.daffodil.api.LocationInSchemaFile
LocationInSchemaFile - Interface in org.apache.daffodil.api: Relevant schema location for a diagnostic message.
Long - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType

M

make(Properties) - Method in interface org.apache.daffodil.api.validation.ValidatorFactory: The factory method to generate the Validator instance
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetArray
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetComplexElement
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetDocument: Access to the metadata information about this element.
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetElement: Access to the metadata information about this element.
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetItem: All infoset items have access to metadata.
metadata() - Method in interface org.apache.daffodil.api.infoset.InfosetSimpleElement
Metadata - Interface in org.apache.daffodil.api.metadata: This is the supportable API for access to the RuntimeData structures which provide access to static information about a given compiled schema metadata object.
MetadataHandler - Class in org.apache.daffodil.api.metadata: Base class used by clients who want to walk the runtime1 metadata information.
MetadataHandler() - Constructor for class org.apache.daffodil.api.metadata.MetadataHandler
minimizedScope() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
ModelGroupMetadata - Interface in org.apache.daffodil.api.metadata: Access to metadata values shared by both sequences and choices which are known collectively as Model Groups.

N

name() - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
name() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
name() - Element in annotation interface org.apache.daffodil.api.udf.UserDefinedFunctionIdentification: Get the local name that identifies the user defined function
name() - Method in interface org.apache.daffodil.api.validation.ValidatorFactory: Unique name of this Validator service
namespace() - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
namespace() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
namespaceURI() - Element in annotation interface org.apache.daffodil.api.udf.UserDefinedFunctionIdentification: Get the namespace URI that identifies the user defined function
newContentHandlerInstance(WritableByteChannel) - Method in interface org.apache.daffodil.api.DataProcessor
newDaffodilDebugger(DaffodilDebuggerRunner) - Static method in class org.apache.daffodil.api.Daffodil: Factory method to get a Debugger that is controlled by a DaffodilDebuggerRunner.
newInputSourceDataInputStream(byte[]) - Static method in class org.apache.daffodil.api.Daffodil: Create an InputSourceDataInputStream from a byte array
newInputSourceDataInputStream(InputStream) - Static method in class org.apache.daffodil.api.Daffodil: Create an InputSourceDataInputStream from a java.io.InputStream
newInputSourceDataInputStream(ByteBuffer) - Static method in class org.apache.daffodil.api.Daffodil: Create an InputSourceDataInputStream from a java.nio.ByteBuffer
newJDOMInfosetInputter(Document) - Static method in class org.apache.daffodil.api.Daffodil: InfosetInputter to read an infoset represented as an org.jdom2.Document
newJDOMInfosetOutputter() - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as an org.jdom2.Document
newJsonInfosetInputter(InputStream) - Static method in class org.apache.daffodil.api.Daffodil: InfosetInputter to read an infoset represented as JSON from a java.io.InputStream
newJsonInfosetOutputter(OutputStream, boolean) - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as JSON written to a java.io.OutputStream Output the infoset as json text, written to a java.io.OutputStream
newNullInfosetOutputter() - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter that does not build an infoset representation, ignoring all InfosetOutputter events
newScalaXMLInfosetInputter(Node) - Static method in class org.apache.daffodil.api.Daffodil: InfosetInputter to read an infoset represented as a scala.xml.Node
newScalaXMLInfosetOutputter() - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as a scala.xml.Node
newTraceDebugger(PrintStream) - Static method in class org.apache.daffodil.api.Daffodil: Factory method to get a debugger that provides verbose trace output to a PrintStream
newW3CDOMInfosetInputter(Document) - Static method in class org.apache.daffodil.api.Daffodil: InfosetInputter to read an infoset represented as an org.w3c.dom.Document
newW3CDOMInfosetOutputter() - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as an org.w3c.dom.Document
newXMLReaderInstance() - Method in interface org.apache.daffodil.api.DataProcessor
newXMLTextInfosetInputter(InputStream) - Static method in class org.apache.daffodil.api.Daffodil: InfosetInputter to read an infoset represented as XML from a java.io.InputStream
newXMLTextInfosetOutputter(OutputStream, boolean) - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as XML written to a java.io.OutputStream
newXMLTextInfosetOutputter(OutputStream, boolean, XMLTextEscapeStyle) - Static method in class org.apache.daffodil.api.Daffodil: InfosetOutputter to build an infoset represented as XML written to a java.io.OutputStream
next() - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Move the internal state to the next event.
NonNegativeInteger - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType

O

onPath(String) - Method in interface org.apache.daffodil.api.ProcessorFactory: Create a DataProcessor
org.apache.daffodil.api - package org.apache.daffodil.api: Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics
org.apache.daffodil.api.debugger - package org.apache.daffodil.api.debugger: Provides the classes necessary to perform parse tracing or create a custom debugger
org.apache.daffodil.api.exceptions - package org.apache.daffodil.api.exceptions
org.apache.daffodil.api.infoset - package org.apache.daffodil.api.infoset
org.apache.daffodil.api.layers - package org.apache.daffodil.api.layers: Daffodil Layers API Package
org.apache.daffodil.api.layers.exceptions - package org.apache.daffodil.api.layers.exceptions
org.apache.daffodil.api.metadata - package org.apache.daffodil.api.metadata
org.apache.daffodil.api.udf - package org.apache.daffodil.api.udf: User Defined Functions
org.apache.daffodil.api.udf.exceptions - package org.apache.daffodil.api.udf.exceptions
org.apache.daffodil.api.validation - package org.apache.daffodil.api.validation: Daffodil Validation API package

P

parse(byte[]) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Parse input data from an array of bytes.
parse(InputStream) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Parse input data from an InputStream.
parse(String) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Parse data from a system identifier/URI.
parse(InputSourceDataInputStream) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Parse input data from an InputSourceDataInputStream.
parse(InputSourceDataInputStream, InfosetOutputter) - Method in interface org.apache.daffodil.api.DataProcessor: Parse input data from an InputSourceDataInputStream and output the infoset to an InfosetOutputter
parse(InputSource) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Parse input data from an InputSource.
ParseResult - Interface in org.apache.daffodil.api: Result of calling DataProcessor.parse(input:org\.apache\.daffodil* DataProcessor.parse, containing any diagnostic information, and the final data location
prefix() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
processingError(String) - Method in class org.apache.daffodil.api.layers.Layer: Use to report a processing error.
processingError(Throwable) - Method in class org.apache.daffodil.api.layers.Layer: Use to report a processing error.
processingInstruction(String, String) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
ProcessorFactory - Interface in org.apache.daffodil.api: Factory to create DataProcessors, used for parsing data

R

reload(File) - Method in interface org.apache.daffodil.api.Compiler: Reload a saved parser from a file
reload(ReadableByteChannel) - Method in interface org.apache.daffodil.api.Compiler: Reload a saved parser from a java.nio.channels.ReadableByteChannel
reset() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Reset the internal state of this InfosetOutputter.
Result - Interface in org.apache.daffodil.api: Interface for Parse and Unparse results
runtimeProperties() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata: Provides access to the runtime properties.
runtimeSchemaDefinitionError(String) - Method in class org.apache.daffodil.api.layers.Layer: Use to report a runtime schema definition error.
runtimeSchemaDefinitionError(Throwable) - Method in class org.apache.daffodil.api.layers.Layer: Use to report a runtime schema definition error.

S

save(WritableByteChannel) - Method in interface org.apache.daffodil.api.DataProcessor: Save the DataProcessor
ScalaXMLInfosetOutputter - Class in org.apache.daffodil.api.infoset: InfosetOutputter whose result is represented as a scala.xml.Node
ScalaXMLInfosetOutputter() - Constructor for class org.apache.daffodil.api.infoset.ScalaXMLInfosetOutputter
schemaFileInfo() - Method in interface org.apache.daffodil.api.metadata.Metadata: Provides the file context of a metadata component.
schemaFileLineColumnNumber() - Method in interface org.apache.daffodil.api.metadata.Metadata: Provides the column number within the text line, to go with `schemaFileLineNumber`.
schemaFileLineNumber() - Method in interface org.apache.daffodil.api.metadata.Metadata: Provides the line number to go with `schemaFileInfo`.
SequenceMetadata - Interface in org.apache.daffodil.api.metadata: Access to metadata values specific to sequences
setBlobAttributes(Path, String, String) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Set the attributes for how to create blob files.
setBlobPaths(List<Path>) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Set the list of blob paths
setContentHandler(ContentHandler) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Register a content handler
setDocumentLocator(Locator) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
setDTDHandler(DTDHandler) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Register a DTD Handler
setEntityResolver(EntityResolver) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Register an entity resolver
setErrorHandler(ErrorHandler) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Register an error handler
setFeature(String, boolean) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Set the value of the feature flag
setLayerRuntime(LayerRuntime) - Method in class org.apache.daffodil.api.layers.Layer: For framework use.
setProcessingErrorException(Class<? extends Exception>) - Method in class org.apache.daffodil.api.layers.Layer: Use to add an exception class to the list of exceptions that will be automatically converted into processing errors.
setProperty(String, Object) - Method in interface org.apache.daffodil.api.DaffodilParseXMLReader: Set the value of the property
setSupportsNamespaces(boolean) - Method in class org.apache.daffodil.api.infoset.InfosetInputter: Set if this infoset inputter supports namespaces.
Short - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
simpleElementMetadata(SimpleElementMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for simple type element metadata (for declarations or references)
SimpleElementMetadata - Interface in org.apache.daffodil.api.metadata: Access to metadata values exclusive to elements of simple type.
skippedEntity(String) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
Standard - Enum constant in enum class org.apache.daffodil.api.infoset.XMLTextEscapeStyle: Special characters (quotation mark, ampersand, less-than, greater-than) in the text of xs:string elements are escaped, while non-special characters are written as is.
startArray(InfosetArray) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the beginning of an array of elements.
startChoiceMetadata(ChoiceMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for choice group definitions.
startComplex(InfosetComplexElement) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the beginning of a complex element.
startComplexElementMetadata(ComplexElementMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for complex type element metadata (for declarations or references)
startDocument() - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
startDocument() - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the beginning of the infoset.
StartDocument - Enum constant in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType
startElement(String, String, String, Attributes) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
StartElement - Enum constant in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType
startPrefixMapping(String, String) - Method in interface org.apache.daffodil.api.DaffodilUnparseContentHandler
startSequenceMetadata(SequenceMetadata) - Method in class org.apache.daffodil.api.metadata.MetadataHandler: Called for sequence group definitions.
startSimple(InfosetSimpleElement) - Method in class org.apache.daffodil.api.infoset.InfosetOutputter: Called by Daffodil internals to signify the beginning of a simple element.
String - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType

T

TermMetadata - Interface in org.apache.daffodil.api.metadata: Provides metadata access that is common to all Terms, which include Elements of simple or complex type, as well as the Sequence and Choice groups.
Time - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
toQName() - Method in interface org.apache.daffodil.api.metadata.ElementMetadata
toString() - Method in interface org.apache.daffodil.api.DataLocation
toString() - Method in exception org.apache.daffodil.api.Diagnostic: Get a string containing the mode name, message, schema location, and data location combined into a single string

U

unparse(InfosetInputter, WritableByteChannel) - Method in interface org.apache.daffodil.api.DataProcessor: Unparse (i.e serializes) data from an InfosetInputter to the output
UnparseResult - Interface in org.apache.daffodil.api: Result of calling DataProcessor#unparse(InfosetInputter, java.nio.channels.WritableByteChannel), containing diagnostic information
UnsignedByte - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
UnsignedInt - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
UnsignedLong - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
UnsignedShort - Enum constant in enum class org.apache.daffodil.api.DFDLPrimType
UserDefinedFunction - Interface in org.apache.daffodil.api.udf: Interface that all User Defined Functions classes must implement.
UserDefinedFunctionFatalException - Exception in org.apache.daffodil.api.udf.exceptions: Exception to throw to abort parsing/unparsing.
UserDefinedFunctionFatalException(String) - Constructor for exception org.apache.daffodil.api.udf.exceptions.UserDefinedFunctionFatalException: Constructs a new exception with a specified detail message
UserDefinedFunctionFatalException(Throwable) - Constructor for exception org.apache.daffodil.api.udf.exceptions.UserDefinedFunctionFatalException: Constructs a new exception with a specified cause
UserDefinedFunctionIdentification - Annotation Interface in org.apache.daffodil.api.udf: Annotation that must be applied to every UDF in order for it to be considered valid.
UserDefinedFunctionProcessingError - Exception in org.apache.daffodil.api.udf.exceptions: Exception to throw to cause backtracking during parsing/unparsing.
UserDefinedFunctionProcessingError(String) - Constructor for exception org.apache.daffodil.api.udf.exceptions.UserDefinedFunctionProcessingError: Constructs a new exception with a specified detail message
UserDefinedFunctionProcessingError(String, Throwable) - Constructor for exception org.apache.daffodil.api.udf.exceptions.UserDefinedFunctionProcessingError: Constructs a new exception with a specified detail message and cause
UserDefinedFunctionProcessingError(Throwable) - Constructor for exception org.apache.daffodil.api.udf.exceptions.UserDefinedFunctionProcessingError: Constructs a new exception with a specified cause
UserDefinedFunctionProvider - Class in org.apache.daffodil.api.udf: Abstract class used by ServiceLoader to poll for UDF providers on classpath.
UserDefinedFunctionProvider() - Constructor for class org.apache.daffodil.api.udf.UserDefinedFunctionProvider

V

validateXML(InputStream, ValidationHandler) - Method in interface org.apache.daffodil.api.validation.Validator: Used to validate XMLs.
validationError(String, Object...) - Method in interface org.apache.daffodil.api.validation.ValidationHandler: Handle validation error with string message
validationErrorNoContext(Throwable) - Method in interface org.apache.daffodil.api.validation.ValidationHandler: Handle validation error with Throwable cause
ValidationHandler - Interface in org.apache.daffodil.api.validation: Validation Handler class to facilitate handling validation errors
Validator - Interface in org.apache.daffodil.api.validation: Implement this trait to provide custom validation logic
ValidatorFactory - Interface in org.apache.daffodil.api.validation: Implement this trait and register with SPI to provide runtime discovery of Validator implementations
ValidatorInitializationException - Exception in org.apache.daffodil.api.validation: Exception to be thrown when initialization of a validator fails
ValidatorInitializationException(String) - Constructor for exception org.apache.daffodil.api.validation.ValidatorInitializationException: Constructor for exception with string message
ValidatorNotRegisteredException - Exception in org.apache.daffodil.api.validation: Exception thrown for failed registration of a validator
Validators - Class in org.apache.daffodil.api.validation: Access SPI registered ValidatorFactory instances.
valueOf(String) - Static method in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.daffodil.api.DFDLPrimType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.daffodil.api.infoset.XMLTextEscapeStyle: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.daffodil.api.Daffodil.InfosetInputterEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.daffodil.api.DFDLPrimType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.daffodil.api.infoset.XMLTextEscapeStyle: Returns an array containing the constants of this enum class, in the order they are declared.

W

W3CDOMInfosetOutputter - Class in org.apache.daffodil.api.infoset: InfosetOutputter whose result is represented as an org.w3c.dom.Document
W3CDOMInfosetOutputter() - Constructor for class org.apache.daffodil.api.infoset.W3CDOMInfosetOutputter
walkMetadata(MetadataHandler) - Method in interface org.apache.daffodil.api.DataProcessor: Walks the handler over the runtime metadata structures
withDebugger(Debugger) - Method in interface org.apache.daffodil.api.DataProcessor: Obtain a new DataProcessor with a specified debugger or null to disable debugging.
WithDiagnostics - Interface in org.apache.daffodil.api: Interface that adds diagnostic information to classes that extend it.
withDistinguishedRootNode(String, String) - Method in interface org.apache.daffodil.api.ProcessorFactory: Get a new ProcessorFactory
withExternalVariables(File) - Method in interface org.apache.daffodil.api.DataProcessor: Obtain a new DataProcessor with external variables read from a Daffodil configuration file
withExternalVariables(Map<String, String>) - Method in interface org.apache.daffodil.api.DataProcessor: Obtain a new DataProcessor with multiple DFDL variables set.
withTunable(String, String) - Method in interface org.apache.daffodil.api.Compiler: Return a new Compiler with a specific Daffodil tunable parameter
withTunables(Map<String, String>) - Method in interface org.apache.daffodil.api.Compiler: Return a new Compiler with multiple tunable parameters
withValidation(String) - Method in interface org.apache.daffodil.api.DataProcessor: Obtain a new DataProcessor with validation that does not require configuration.
withValidation(String, URL) - Method in interface org.apache.daffodil.api.DataProcessor: Obtain a new DataProcessor with validation using a URI for configuration.
wrapLayerInput(InputStream) - Method in class org.apache.daffodil.api.layers.Layer: Wraps a layer input decoder around an input stream.
wrapLayerOutput(OutputStream) - Method in class org.apache.daffodil.api.layers.Layer: Wraps a layer output encoder around an output stream.

X

XMLTextEscapeStyle - Enum Class in org.apache.daffodil.api.infoset: XMLTextEscapeStyles for determining whether to wrap info in CDATA tags

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form