Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
B
- brandingFile() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- brandingFile() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- build() - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Builds a new
XSProcessorRequest. - builder() - Static method in class com.io7m.xstructural.api.XSProcessorRequest
-
Creates a builder for
XSProcessorRequest.
C
- call(XdmValue[]) - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSMIMEExtensionFunction
- call(XdmValue[]) - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSTitleCaseExtensionFunction
- characters(char[], int, int) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- characters(char[], int, int) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- checkPreconditions() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
-
Check preconditions for the type.
- children() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Returns the value of the
childrenrecord component. - close() - Method in class com.io7m.xstructural.vanilla.internal.XSMessageListener
- column() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns the value of the
columnrecord component. - com.io7m.xstructural.api - package com.io7m.xstructural.api
-
XStructural (API)
- com.io7m.xstructural.cmdline - package com.io7m.xstructural.cmdline
-
Command-line interface.
- com.io7m.xstructural.cmdline.internal - package com.io7m.xstructural.cmdline.internal
-
Command-line interface (internal classes).
- com.io7m.xstructural.vanilla - package com.io7m.xstructural.vanilla
-
XStructural (Vanilla)
- com.io7m.xstructural.vanilla.internal - package com.io7m.xstructural.vanilla.internal
-
XStructural (Vanilla internal classes)
- com.io7m.xstructural.vanilla.internal.format - package com.io7m.xstructural.vanilla.internal.format
-
Source formatter for xstructural XML documents.
- com.io7m.xstructural.vanilla.internal.xslt_extensions - package com.io7m.xstructural.vanilla.internal.xslt_extensions
-
XStructural (XSLT extension functions)
- com.io7m.xstructural.xml - package com.io7m.xstructural.xml
-
XStructural XML resources.
- com.io7m.xstructural.xml.org.w3c - package com.io7m.xstructural.xml.org.w3c
-
XStructural XML resources.
- com.io7m.xstructural.xml.org.w3c.xhtml - package com.io7m.xstructural.xml.org.w3c.xhtml
-
XStructural XML resources.
- copyOf(XSProcessorRequestType) - Static method in class com.io7m.xstructural.api.XSProcessorRequest
-
Creates an immutable copy of a
XSProcessorRequestTypevalue. - create(XSProcessorRequest) - Method in interface com.io7m.xstructural.api.XSProcessorFactoryType
-
Create a new processor for the given request.
- create(XSProcessorRequest) - Method in class com.io7m.xstructural.vanilla.XSProcessors
- create(Path, Path, Path) - Static method in class com.io7m.xstructural.vanilla.internal.format.XSSourceFormatter
-
Create and execute a formatter.
- create(Path, Path, Path, int) - Static method in class com.io7m.xstructural.vanilla.internal.format.XSSourceFormatter
-
Create and execute a formatter with an explicit line width.
- createXMLReader(Path, SXMLResources) - Method in class com.io7m.xstructural.vanilla.internal.XSSAXParsers
-
Create a XSD-validating XML reader.
- createXMLReaderNonValidating() - Method in class com.io7m.xstructural.vanilla.internal.XSSAXParsers
-
Create a non-validating XML reader.
- cssReset() - Method in class com.io7m.xstructural.xml.SXMLResources
- cssResetEPUB() - Method in class com.io7m.xstructural.xml.SXMLResources
- cssStructural() - Method in class com.io7m.xstructural.xml.SXMLResources
- cssStructuralEPUB() - Method in class com.io7m.xstructural.xml.SXMLResources
- cssStructuralMultiPage() - Method in class com.io7m.xstructural.xml.SXMLResources
- cssStructuralSinglePage() - Method in class com.io7m.xstructural.xml.SXMLResources
D
- DEFAULT_WIDTH - Static variable in class com.io7m.xstructural.vanilla.internal.format.XSSourceFormatter
-
The default maximum line width.
- description() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns the value of the
descriptionrecord component.
E
- element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Returns the value of the
elementrecord component. - element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatData
-
Returns the value of the
elementrecord component. - element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatInline
-
Returns the value of the
elementrecord component. - element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatLeaf
-
Returns the value of the
elementrecord component. - element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Returns the value of the
elementrecord component. - element() - Method in interface com.io7m.xstructural.vanilla.internal.format.XSFormatNodeType
- element() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatVerbatim
-
Returns the value of the
elementrecord component. - encoding() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns the value of the
encodingrecord component. - endDocument() - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- endDocument() - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- endElement(String, String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- endElement(String, String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- endPrefixMapping(String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- endPrefixMapping(String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- EPUB - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
The EPUB stylesheet.
- equals(Object) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
This instance is equal to all instances of
XSProcessorRequestthat have equal attribute values. - equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatInline
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatLeaf
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatVerbatim
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclarationCollection
-
Indicates whether some other object is "equal to" this one.
- error(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSErrorHandler
- error(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- error(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- execute() - Method in interface com.io7m.xstructural.api.XSProcessorType
-
Execute the processor.
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSEPUBCreator
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSEPUBPackageCreator
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSProcessor
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSTransformer
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
-
Execute the validator.
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSValidator
- execute() - Method in class com.io7m.xstructural.vanilla.internal.XSXHTMLValidator
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
-
Execute the command.
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandFormatXML
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandSchema
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformEPUB
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformMarkdown
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformXHTML
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandValidate
- execute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSCommandValidateXHTML
- exitCode() - Method in class com.io7m.xstructural.cmdline.Main
F
- fatalError(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSErrorHandler
- fatalError(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- fatalError(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- findProcessors() - Static method in class com.io7m.xstructural.cmdline.internal.XSServices
- fixDocumentNumber(XsltTransformer) - Static method in class com.io7m.xstructural.vanilla.internal.XSDocumentNumbering
-
When the XSLT processor transforms a document, it uses a document number allocator that will be called when XSLT code calls generate-id().
- format(Path, Path, Path, int) - Static method in class com.io7m.xstructural.vanilla.XSFormat
-
Format the input document, writing it to the temporary output document and then atomically renaming the temporary output to the actual output.
- from(XSProcessorRequestType) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Fill a builder with attribute values from the provided
XSProcessorRequestTypeinstance.
G
- getArgumentTypes() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSMIMEExtensionFunction
- getArgumentTypes() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSTitleCaseExtensionFunction
- getExternalSubset(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityNeverResolver
- getExternalSubset(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityResolver
- getName() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSMIMEExtensionFunction
- getName() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSTitleCaseExtensionFunction
- getResultType() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSMIMEExtensionFunction
- getResultType() - Method in class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSTitleCaseExtensionFunction
H
- hasBom() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns the value of the
hasBomrecord component. - hashCode() - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Computes a hash code from attributes:
outputDirectory,sourceFile,task,stylesheet,writeResources,traceFile,messageFile,brandingFile,outputName,typeDescriptionFile. - hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatInline
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatLeaf
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatVerbatim
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclarationCollection
-
Returns a hash code value for this object.
I
- ignorableWhitespace(char[], int, int) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- ignorableWhitespace(char[], int, int) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- isFailed() - Method in class com.io7m.xstructural.vanilla.internal.XSErrorHandler
- items() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Returns the value of the
itemsrecord component.
L
- LanguageString(Locale, String) - Constructor for record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
A string in a particular language.
- line() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns the value of the
linerecord component. - locale() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
Returns the value of the
localerecord component.
M
- main(String[]) - Static method in class com.io7m.xstructural.cmdline.Main
-
The main entry point.
- main(String[]) - Static method in class com.io7m.xstructural.cmdline.MainExitless
-
The main entry point.
- Main - Class in com.io7m.xstructural.cmdline
-
The xstructural command line application.
- Main(String[]) - Constructor for class com.io7m.xstructural.cmdline.Main
- MAIN_BUILD - Static variable in class com.io7m.xstructural.cmdline.XSMainVersion
- MAIN_VERSION - Static variable in class com.io7m.xstructural.cmdline.XSMainVersion
- MainExitless - Class in com.io7m.xstructural.cmdline
-
Main command line entry point that does not call
exit(). - MARKDOWN - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
The Markdown stylesheet.
- message(XdmNode, QName, boolean, SourceLocator) - Method in class com.io7m.xstructural.vanilla.internal.XSMessageListener
- messageFile() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- messageFile() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- metadata() - Method in class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
- MULTIPLE_FILE - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
The multi-file stylesheet.
- MULTIPLE_FILE_INDEX_ONLY - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
The multiple file index stylesheet.
N
- name() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns the value of the
namerecord component. - namespace7p0() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespace7p0s() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespace8Index() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespace8p0() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespace8p0s() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespace9p0() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespaces() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespaceTypes() - Static method in class com.io7m.xstructural.api.XSSchemas
- namespaceTypes2p0() - Static method in class com.io7m.xstructural.api.XSSchemas
- node() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Returns the value of the
noderecord component. - node() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Returns the value of the
noderecord component.
O
- of(int) - Static method in class com.io7m.xstructural.vanilla.internal.format.XSDOMSerializer
-
Create a serializer.
- onExecute(QCommandContextType) - Method in class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
- onListNamedParameters() - Method in class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandFormatXML
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandSchema
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformEPUB
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformMarkdown
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandTransformXHTML
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandValidate
- onListNamedParametersActual() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandValidateXHTML
- onListPositionalParameters() - Method in class com.io7m.xstructural.cmdline.internal.XSCommandFormatXML
- outputDirectory() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- outputDirectory() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- outputName() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- outputName() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
P
- processingInstruction(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- processingInstruction(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
R
- read(Path) - Static method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Read the prolog from the leading bytes of a file.
- read(Path) - Static method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
-
Load type declarations.
- resolveEntity(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityNeverResolver
- resolveEntity(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityResolver
- resolveEntity(String, String, String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityNeverResolver
- resolveEntity(String, String, String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSEntityResolver
- resolveResource(String, String, String, String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSResourceResolver
- run() - Method in class com.io7m.xstructural.cmdline.Main
S
- s8Epub() - Method in class com.io7m.xstructural.xml.SXMLResources
- s8EpubPackage() - Method in class com.io7m.xstructural.xml.SXMLResources
- s8Index() - Method in class com.io7m.xstructural.xml.SXMLResources
- s8Markdown() - Method in class com.io7m.xstructural.xml.SXMLResources
- s8Multi() - Method in class com.io7m.xstructural.xml.SXMLResources
- s8Single() - Method in class com.io7m.xstructural.xml.SXMLResources
- schema() - Method in class com.io7m.xstructural.xml.SXMLResources
-
Deprecated, for removal: This API element is subject to removal in a future version.
- schema7p0() - Method in class com.io7m.xstructural.xml.SXMLResources
- schema8p0() - Method in class com.io7m.xstructural.xml.SXMLResources
- schema9p0() - Method in class com.io7m.xstructural.xml.SXMLResources
- serialize(Document, XSProlog) - Method in class com.io7m.xstructural.vanilla.internal.format.XSDOMSerializer
-
Serialize a document.
- setBrandingFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
brandingFileto brandingFile. - setBrandingFile(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
brandingFileto brandingFile. - setDocumentLocator(Locator) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- setDocumentLocator(Locator) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- setMessageFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
messageFileattribute. - setOutputDirectory(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
outputDirectoryattribute. - setOutputName(String) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
outputNameto outputName. - setOutputName(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
outputNameto outputName. - setSourceFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
sourceFileattribute. - setStylesheet(XSProcessorRequestType.Stylesheet) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
stylesheetattribute. - setTask(XSProcessorRequestType.Task) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
taskattribute. - setTraceFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
traceFileattribute. - setTypeDescriptionFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
typeDescriptionFileto typeDescriptionFile. - setTypeDescriptionFile(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the optional value
typeDescriptionFileto typeDescriptionFile. - setWriteResources(boolean) - Method in class com.io7m.xstructural.api.XSProcessorRequest.Builder
-
Initializes the value for the
writeResourcesattribute. - SINGLE_FILE - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
The single-file stylesheet.
- skippedEntity(String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- skippedEntity(String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- source() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns the value of the
sourcerecord component. - sourceFile() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- sourceFile() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- spaceBefore() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Returns the value of the
spaceBeforerecord component. - spaceBefore() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Returns the value of the
spaceBeforerecord component. - spaceBefore() - Method in interface com.io7m.xstructural.vanilla.internal.format.XSFormatItemType
- spaceBefore() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Returns the value of the
spaceBeforerecord component. - standalone() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns the value of the
standalonerecord component. - startDocument() - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- startDocument() - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- startElement(String, String, String, Attributes) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- startElement(String, String, String, Attributes) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- startPrefixMapping(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- startPrefixMapping(String, String) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- stylesheet() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- stylesheet() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- SXMLResources - Class in com.io7m.xstructural.xml
-
Resources exposed by the module.
- SXMLResources() - Constructor for class com.io7m.xstructural.xml.SXMLResources
-
Construct a resource provider.
T
- task() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- task() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- text() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Returns the value of the
textrecord component. - text() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
Returns the value of the
textrecord component. - toString() - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Prints the immutable value
XSProcessorRequestwith attribute values. - toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatData
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatInline
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatLeaf
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatVerbatim
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration.LanguageString
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
Returns a string representation of this record class.
- toString() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclarationCollection
-
Returns a string representation of this record class.
- traceFile() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- traceFile() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- TRANSFORM_EPUB - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
The input document will be transformed to an EPUB.
- TRANSFORM_MARKDOWN - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
The input document will be transformed to Markdown.
- TRANSFORM_XHTML - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
The input document will be transformed to XHTML.
- typeDescriptionFile() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- typeDescriptionFile() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
- types() - Method in record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclarationCollection
-
Returns the value of the
typesrecord component.
V
- VALIDATE - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
The input document will be validated, and no other steps will be performed.
- VALIDATE_XHTML - Enum constant in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
The input XHTML will be validated, and no other steps will be performed.
- valueOf(String) - Static method in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.io7m.xstructural.api.XSProcessorRequestType.Stylesheet
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.io7m.xstructural.api.XSProcessorRequestType.Task
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Returns the value of the
versionrecord component.
W
- W3CMarker - Class in com.io7m.xstructural.xml.org.w3c
-
W3C marker class.
- W3CXHTMLMarker - Class in com.io7m.xstructural.xml.org.w3c.xhtml
-
W3C XHTML marker class.
- W3CXHTMLMarker() - Constructor for class com.io7m.xstructural.xml.org.w3c.xhtml.W3CXHTMLMarker
-
W3C XHTML marker class.
- w3cXHTMLResourceOf(String) - Method in class com.io7m.xstructural.xml.SXMLResources
-
Find a W3C XHTML schema resource.
- w3cXHTMLResources() - Method in class com.io7m.xstructural.xml.SXMLResources
- w3cXHTMLSchema() - Method in class com.io7m.xstructural.xml.SXMLResources
- warning(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSErrorHandler
- warning(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeLoader
- warning(SAXParseException) - Method in class com.io7m.xstructural.vanilla.internal.XSTypeValidator
- withBrandingFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a present value for the optional
brandingFileattribute. - withBrandingFile(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting an optional value for the
brandingFileattribute. - withMessageFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
messageFileattribute. - withOutputDirectory(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
outputDirectoryattribute. - withOutputName(String) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a present value for the optional
outputNameattribute. - withOutputName(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting an optional value for the
outputNameattribute. - withSourceFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
sourceFileattribute. - withStylesheet(XSProcessorRequestType.Stylesheet) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
stylesheetattribute. - withTask(XSProcessorRequestType.Task) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
taskattribute. - withTraceFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
traceFileattribute. - withTypeDescriptionFile(Path) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a present value for the optional
typeDescriptionFileattribute. - withTypeDescriptionFile(Optional) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting an optional value for the
typeDescriptionFileattribute. - withWriteResources(boolean) - Method in class com.io7m.xstructural.api.XSProcessorRequest
-
Copy the current immutable object by setting a value for the
writeResourcesattribute. - writeResources() - Method in class com.io7m.xstructural.api.XSProcessorRequest
- writeResources() - Method in interface com.io7m.xstructural.api.XSProcessorRequestType
X
- XSAbstractCommand - Class in com.io7m.xstructural.cmdline.internal
-
A base class for command implementations, adding the standard verbose parameter and configuring the log level prior to execution.
- XSAbstractCommand(QCommandMetadata) - Constructor for class com.io7m.xstructural.cmdline.internal.XSAbstractCommand
- XSCommandFormatXML - Class in com.io7m.xstructural.cmdline.internal
-
Format one or more structural files in place.
- XSCommandFormatXML() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandFormatXML
-
Construct a command.
- XSCommandSchema - Class in com.io7m.xstructural.cmdline.internal
-
Export the structural schemas to files.
- XSCommandSchema() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandSchema
-
Construct a command.
- XSCommandTransformEPUB - Class in com.io7m.xstructural.cmdline.internal
-
Transform a structural document into an EPUB file.
- XSCommandTransformEPUB() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandTransformEPUB
-
Construct a command.
- XSCommandTransformMarkdown - Class in com.io7m.xstructural.cmdline.internal
-
Transform a structural document into Markdown.
- XSCommandTransformMarkdown() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandTransformMarkdown
-
Construct a command.
- XSCommandTransformXHTML - Class in com.io7m.xstructural.cmdline.internal
-
Transform a structural document into XHTML.
- XSCommandTransformXHTML() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandTransformXHTML
-
Construct a command.
- XSCommandValidate - Class in com.io7m.xstructural.cmdline.internal
-
Validate a structural document.
- XSCommandValidate() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandValidate
-
Construct a command.
- XSCommandValidateXHTML - Class in com.io7m.xstructural.cmdline.internal
-
Validate an XHTML file.
- XSCommandValidateXHTML() - Constructor for class com.io7m.xstructural.cmdline.internal.XSCommandValidateXHTML
-
Construct a command.
- XSDocumentNumbering - Class in com.io7m.xstructural.vanilla.internal
-
Functions to reset document numbering in Saxon.
- XSDOMSerializer - Class in com.io7m.xstructural.vanilla.internal.format
-
Serializes an
Documentto an XML 1.0 string. - xsdResourceOf(String) - Method in class com.io7m.xstructural.xml.SXMLResources
-
Find an XSD resource with the given name.
- xsdResources() - Method in class com.io7m.xstructural.xml.SXMLResources
- XSEntityNeverResolver - Class in com.io7m.xstructural.vanilla.internal
-
A resource resolver.
- XSEntityNeverResolver() - Constructor for class com.io7m.xstructural.vanilla.internal.XSEntityNeverResolver
-
A resource resolver.
- XSEntityResolver - Class in com.io7m.xstructural.vanilla.internal
-
A resource resolver.
- XSEntityResolver(Path, SXMLResources) - Constructor for class com.io7m.xstructural.vanilla.internal.XSEntityResolver
-
A resource resolver.
- XSEPUBCreator - Class in com.io7m.xstructural.vanilla.internal
-
An EPUB creator.
- XSEPUBCreator(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSEPUBCreator
-
An EPUB creator.
- XSEPUBPackageCreator - Class in com.io7m.xstructural.vanilla.internal
-
An XSL EPUB package creator.
- XSEPUBPackageCreator(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSEPUBPackageCreator
-
An XSL transformer.
- XSErrorHandler - Class in com.io7m.xstructural.vanilla.internal
-
An error handler that logs messages and tracks the failure state.
- XSErrorHandler(Logger) - Constructor for class com.io7m.xstructural.vanilla.internal.XSErrorHandler
-
An error handler.
- XSFormat - Class in com.io7m.xstructural.vanilla
-
Functions to format structural XML documents.
- XSFormatBlock - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A block element: contains element children only.
- XSFormatBlock(Element, List) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatBlock
-
Constructor.
- XSFormatData - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A data element: a text-bearing leaf (no element children).
- XSFormatData(Element) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatData
-
Constructor.
- XSFormatInline - Record Class in com.io7m.xstructural.vanilla.internal.format
-
An inline element: atomic, contains text only.
- XSFormatInline(Element) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatInline
-
Constructor.
- XSFormatItemBlock - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A nested block element reference within mixed content.
- XSFormatItemBlock(boolean, XSFormatNodeType) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemBlock
-
Constructor.
- XSFormatItemInline - Record Class in com.io7m.xstructural.vanilla.internal.format
-
An inline element reference within mixed content.
- XSFormatItemInline(boolean, XSFormatNodeType) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatItemInline
-
Constructor.
- XSFormatItemType - Interface in com.io7m.xstructural.vanilla.internal.format
-
An item in the content of a mixed element.
- XSFormatLeaf - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A leaf element: no children, no text (e.g.,
xi:include). - XSFormatLeaf(Element) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatLeaf
-
Constructor.
- XSFormatMixed - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A mixed-content element: contains text and inline/block children.
- XSFormatMixed(Element, List) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatMixed
-
Constructor.
- XSFormatNodeType - Interface in com.io7m.xstructural.vanilla.internal.format
-
A node in the abstract format tree, holding a reference to the source
Element. - XSFormatVerbatim - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A verbatim element: contains a CDATA section reproduced byte-for-byte.
- XSFormatVerbatim(Element) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatVerbatim
-
Constructor.
- XSFormatWord - Record Class in com.io7m.xstructural.vanilla.internal.format
-
A word: a maximal run of non-whitespace text.
- XSFormatWord(boolean, String) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSFormatWord
-
Constructor.
- XSMainVersion - Class in com.io7m.xstructural.cmdline
- XSMessageListener - Class in com.io7m.xstructural.vanilla.internal
-
A message listener.
- XSMIMEExtensionFunction - Class in com.io7m.xstructural.vanilla.internal.xslt_extensions
-
The
mimeOfextension function. - XSMIMEExtensionFunction() - Constructor for class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSMIMEExtensionFunction
-
The
mimeOfextension function. - XSProcessor - Class in com.io7m.xstructural.vanilla.internal
-
An XSL processor.
- XSProcessor(XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSProcessor
-
An XSL processor.
- XSProcessorException - Exception Class in com.io7m.xstructural.api
-
The type of exceptions raised by document processors.
- XSProcessorException(String) - Constructor for exception class com.io7m.xstructural.api.XSProcessorException
-
Construct an exception.
- XSProcessorException(String, Throwable) - Constructor for exception class com.io7m.xstructural.api.XSProcessorException
-
Construct an exception.
- XSProcessorException(Throwable) - Constructor for exception class com.io7m.xstructural.api.XSProcessorException
-
Construct an exception.
- XSProcessorFactoryType - Interface in com.io7m.xstructural.api
-
The type of processor factories.
- XSProcessorRequest - Class in com.io7m.xstructural.api
-
A document processor request.
- XSProcessorRequest.Builder - Class in com.io7m.xstructural.api
-
Builds instances of type
XSProcessorRequest. - XSProcessorRequestType - Interface in com.io7m.xstructural.api
-
A document processor request.
- XSProcessorRequestType.Stylesheet - Enum Class in com.io7m.xstructural.api
-
The stylesheet that will be used during processing.
- XSProcessorRequestType.Task - Enum Class in com.io7m.xstructural.api
-
A document processor task.
- XSProcessors - Class in com.io7m.xstructural.vanilla
-
The default processor factory.
- XSProcessors() - Constructor for class com.io7m.xstructural.vanilla.XSProcessors
-
Construct a processor factory.
- XSProcessorType - Interface in com.io7m.xstructural.api
-
The type of document processors.
- XSProlog - Record Class in com.io7m.xstructural.vanilla.internal.format
-
The XML declaration and byte-order mark of a document, captured from the input so that it can be repeated verbatim in the formatted output.
- XSProlog(String, String, int, boolean) - Constructor for record class com.io7m.xstructural.vanilla.internal.format.XSProlog
-
Constructor.
- XSResourceResolver - Class in com.io7m.xstructural.vanilla.internal
-
A resource resolver.
- XSResourceResolver(SXMLResources) - Constructor for class com.io7m.xstructural.vanilla.internal.XSResourceResolver
-
A resource resolver.
- XSSAXParsers - Class in com.io7m.xstructural.vanilla.internal
-
A provider of hardened SAX parsers.
- XSSAXParsers() - Constructor for class com.io7m.xstructural.vanilla.internal.XSSAXParsers
-
Construct a provider.
- XSSchemas - Class in com.io7m.xstructural.api
-
The known structural schemas.
- XSServices - Class in com.io7m.xstructural.cmdline.internal
-
Functions over services.
- XSSourceFormatter - Class in com.io7m.xstructural.vanilla.internal.format
-
A source formatter for xstructural XML documents.
- XSTitleCaseExtensionFunction - Class in com.io7m.xstructural.vanilla.internal.xslt_extensions
-
The
titleCaseOfextension function. - XSTitleCaseExtensionFunction() - Constructor for class com.io7m.xstructural.vanilla.internal.xslt_extensions.XSTitleCaseExtensionFunction
-
The
titleCaseOfextension function. - XSTransformer - Class in com.io7m.xstructural.vanilla.internal
-
An XSL transformer.
- XSTransformer(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSTransformer
-
An XSL transformer.
- XSTransformException - Exception Class in com.io7m.xstructural.api
-
The type of exceptions raised due to transform failures.
- XSTransformException(String) - Constructor for exception class com.io7m.xstructural.api.XSTransformException
-
Construct an exception.
- XSTransformException(String, Throwable) - Constructor for exception class com.io7m.xstructural.api.XSTransformException
-
Construct an exception.
- XSTransformException(Throwable) - Constructor for exception class com.io7m.xstructural.api.XSTransformException
-
Construct an exception.
- xstructuralResourceOf(String) - Method in class com.io7m.xstructural.xml.SXMLResources
-
Find the xstructural resource with the given name.
- xstructuralResources() - Method in class com.io7m.xstructural.xml.SXMLResources
- XSTypeAttributeDeclaration - Record Class in com.io7m.xstructural.vanilla.internal
-
A type attribute declaration.
- XSTypeAttributeDeclaration(URI, int, int, String, Map) - Constructor for record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclaration
-
A type attribute declaration.
- XSTypeAttributeDeclaration.LanguageString - Record Class in com.io7m.xstructural.vanilla.internal
-
A string in a particular language.
- XSTypeAttributeDeclarationCollection - Record Class in com.io7m.xstructural.vanilla.internal
-
A collection of type attribute declarations.
- XSTypeAttributeDeclarationCollection(Map) - Constructor for record class com.io7m.xstructural.vanilla.internal.XSTypeAttributeDeclarationCollection
-
A collection of type attribute declarations.
- XSTypeLoader - Class in com.io7m.xstructural.vanilla.internal
-
A loader for type declarations.
- XSTypeValidator - Class in com.io7m.xstructural.vanilla.internal
-
A type attribute validator.
- XSTypeValidator(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSTypeValidator
-
A type attribute validator.
- XSValidationException - Exception Class in com.io7m.xstructural.api
-
The type of exceptions raised due to validation failures.
- XSValidationException(String) - Constructor for exception class com.io7m.xstructural.api.XSValidationException
-
Construct an exception.
- XSValidationException(String, Throwable) - Constructor for exception class com.io7m.xstructural.api.XSValidationException
-
Construct an exception.
- XSValidationException(Throwable) - Constructor for exception class com.io7m.xstructural.api.XSValidationException
-
Construct an exception.
- XSValidator - Class in com.io7m.xstructural.vanilla.internal
-
A validator.
- XSValidator(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSValidator
-
A validator.
- XSXHTMLValidator - Class in com.io7m.xstructural.vanilla.internal
-
An XHTML validator.
- XSXHTMLValidator(SXMLResources, XSProcessorRequest) - Constructor for class com.io7m.xstructural.vanilla.internal.XSXHTMLValidator
-
A XHTML validator.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
SXMLResources.schema7p0()