A B C D E F G H I J O R S T V W

A

Annotation - Interface in org.scribble.common.model

This interface represents an annotation associated with a protocol model object.

apply(Journal) - Method in class org.scribble.common.logging.CachedJournal

This method applies any cached issues to the supplied logger.

B

ByteArrayContent - Class in org.scribble.common.resource

This class represents byte array content to be used by the Scribble tools.

ByteArrayContent(byte[]) - Constructor for class org.scribble.common.resource.ByteArrayContent

This construct is initialized with the byte array.

C

CachedJournal - Class in org.scribble.common.logging

This class provides an implementation of the journal that caches reported issues.

CachedJournal() - Constructor for class org.scribble.common.logging.CachedJournal

CachedJournal.IssueDetails - Class in org.scribble.common.logging

This class represents the issue details.

CachedJournal.IssueDetails(CachedJournal.IssueType, String, Map<String, Object>) - Constructor for class org.scribble.common.logging.CachedJournal.IssueDetails

Constructor for the issue details.

CachedJournal.IssueType - Enum in org.scribble.common.logging

This enum represents the type of issue.

ConsoleJournal - Class in org.scribble.common.logging

This class provides an implementation of the journal that reports issues to the console.

ConsoleJournal() - Constructor for class org.scribble.common.logging.ConsoleJournal

Content - Interface in org.scribble.common.resource

This interface represents content to be used by the Scribble tools.

D

DefaultAnnotation - Class in org.scribble.common.model

This class represents the default implementation of the annotation interface.

DefaultAnnotation(String) - Constructor for class org.scribble.common.model.DefaultAnnotation

This is the constructor, initialized with the annotation text.

DefaultAnnotation(String, String) - Constructor for class org.scribble.common.model.DefaultAnnotation

This is the constructor, initialized with the optional id and annotation text.

DefaultResourceLocator - Class in org.scribble.common.resource

This class represents a default implement of the resource locator interface, that can be used to load artifacts relative to a base location.

DefaultResourceLocator(File) - Constructor for class org.scribble.common.resource.DefaultResourceLocator

This constructor initializes the default resource locator with the location of the base directory from which the relative file paths should be derived.

E

END_COLUMN - Static variable in interface org.scribble.common.logging.Journal

The end column in the document at which the issue has been detected.

END_LINE - Static variable in interface org.scribble.common.logging.Journal

The end line in the document at which the issue has been detected.

END_POSITION - Static variable in interface org.scribble.common.logging.Journal

The end position in the document at which the issue has been detected.

error(String, Map<String, Object>) - Method in class org.scribble.common.logging.CachedJournal

This method records an error issue.

error(String, Map<String, Object>) - Method in class org.scribble.common.logging.ConsoleJournal

This method records an error issue.

error(String, Map<String, Object>) - Method in interface org.scribble.common.logging.Journal

This method records an error issue.

F

FileContent - Class in org.scribble.common.resource

This class represents file content to be used by the Scribble tools.

FileContent(File) - Constructor for class org.scribble.common.resource.FileContent

This construct is initialized with the file.

G

getId() - Method in interface org.scribble.common.model.Annotation

Optional id for the annotation.

getId() - Method in class org.scribble.common.model.DefaultAnnotation

Optional id for the annotation.

getInputStream() - Method in class org.scribble.common.resource.ByteArrayContent

This method returns the input stream for accessing the content.

getInputStream() - Method in interface org.scribble.common.resource.Content

This method returns the input stream for accessing the content.

getInputStream() - Method in class org.scribble.common.resource.FileContent

This method returns the input stream for accessing the content.

getInputStream() - Method in class org.scribble.common.resource.ResourceContent

This method returns the input stream for accessing the content.

getIssues() - Method in class org.scribble.common.logging.CachedJournal

This method returns the list of issues that have been reported to this journal.

getIssueType() - Method in class org.scribble.common.logging.CachedJournal.IssueDetails

This method returns the issue type.

getMessage() - Method in class org.scribble.common.logging.CachedJournal.IssueDetails

This method returns the message.

getName() - Method in class org.scribble.common.resource.ByteArrayContent

This method returns the content name if available.

getName() - Method in interface org.scribble.common.resource.Content

This method returns the content name if available.

getName() - Method in class org.scribble.common.resource.FileContent

This method returns the content name if available.

getName() - Method in class org.scribble.common.resource.ResourceContent

This method returns the content name if available.

getProperties() - Method in class org.scribble.common.logging.CachedJournal.IssueDetails

This method returns the properties.

getResourceURI(String) - Method in class org.scribble.common.resource.DefaultResourceLocator

This method can be used to retrieve the URI of a resource which is located at the specified URI, potentially relative to a resource that is being processed.

getResourceURI(String) - Method in interface org.scribble.common.resource.ResourceLocator

This method can be used to retrieve the URI of a resource which is located at the specified URI, potentially relative to a resource that is being processed.

H

hasErrors() - Method in class org.scribble.common.logging.CachedJournal

This method determines whether any errors have been reported.

hasExtension(String) - Method in class org.scribble.common.resource.ByteArrayContent

This method determines whether the content has an extension of the specified type.

hasExtension(String) - Method in interface org.scribble.common.resource.Content

This method determines whether the content has an extension of the specified type.

hasExtension(String) - Method in class org.scribble.common.resource.FileContent

This method determines whether the content has an extension of the specified type.

hasExtension(String) - Method in class org.scribble.common.resource.ResourceContent

This method determines whether the content has an extension of the specified type.

hasWarnings() - Method in class org.scribble.common.logging.CachedJournal

This method determines whether any warnings have been reported.

I

info(String, Map<String, Object>) - Method in class org.scribble.common.logging.CachedJournal

This method records an information issue.

info(String, Map<String, Object>) - Method in class org.scribble.common.logging.ConsoleJournal

This method records an information issue.

info(String, Map<String, Object>) - Method in interface org.scribble.common.logging.Journal

This method records an information issue.

isXSDElement(QName) - Method in class org.scribble.common.resource.ByteArrayContent

This method determines whether the content is an XSD element of the value specified.

isXSDElement(QName) - Method in interface org.scribble.common.resource.Content

This method determines whether the content is an XSD element of the value specified.

isXSDElement(QName) - Method in class org.scribble.common.resource.FileContent

This method determines whether the content is an XSD element of the value specified.

isXSDElement(QName) - Method in class org.scribble.common.resource.ResourceContent

This method determines whether the content is an XSD element of the value specified.

isXSDType(QName) - Method in class org.scribble.common.resource.ByteArrayContent

This method determines whether the content is an XSD type of the value specified.

isXSDType(QName) - Method in interface org.scribble.common.resource.Content

This method determines whether the content is an XSD type of the value specified.

isXSDType(QName) - Method in class org.scribble.common.resource.FileContent

This method determines whether the content is an XSD type of the value specified.

isXSDType(QName) - Method in class org.scribble.common.resource.ResourceContent

This method determines whether the content is an XSD type of the value specified.

J

Journal - Interface in org.scribble.common.logging

This interface represents the component used by other scribble modules to record issues.

O

org.scribble.common.logging - package org.scribble.common.logging

org.scribble.common.model - package org.scribble.common.model

org.scribble.common.resource - package org.scribble.common.resource

R

RESOURCE_URL - Static variable in interface org.scribble.common.logging.Journal

The optional resource URL associated with the issue.

ResourceContent - Class in org.scribble.common.resource

This class represents resource content to be used by the Scribble tools.

ResourceContent(URI) - Constructor for class org.scribble.common.resource.ResourceContent

This construct is initialized with the resource URI.

ResourceLocator - Interface in org.scribble.common.resource

This interface represents a resource locator that can be used to load artifacts relative to another resource being processed.

S

setAnnotation(String) - Method in class org.scribble.common.model.DefaultAnnotation

This method sets the annotation.

START_COLUMN - Static variable in interface org.scribble.common.logging.Journal

The start column in the document at which the issue has been detected.

START_LINE - Static variable in interface org.scribble.common.logging.Journal

The start line in the document at which the issue has been detected.

START_POSITION - Static variable in interface org.scribble.common.logging.Journal

The start position in the document at which the issue has been detected.

T

toString() - Method in interface org.scribble.common.model.Annotation

This method generates a text based representation of annotation, that would be exported between [[ and ]] delimitors in the text based scribble representation.

toString() - Method in class org.scribble.common.model.DefaultAnnotation

This method returns the textual representation of the annotation.

V

valueOf(String) - Static method in enum org.scribble.common.logging.CachedJournal.IssueType

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

values() - Static method in enum org.scribble.common.logging.CachedJournal.IssueType

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

W

warning(String, Map<String, Object>) - Method in class org.scribble.common.logging.CachedJournal

This method records a warning issue.

warning(String, Map<String, Object>) - Method in class org.scribble.common.logging.ConsoleJournal

This method records a warning issue.

warning(String, Map<String, Object>) - Method in interface org.scribble.common.logging.Journal

This method records a warning issue.

A B C D E F G H I J O R S T V W