Index

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

A

ABSTRACT_CLASS - Enum constant in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
add(String, TypeName) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters
 
addChild(UMLNode) - Method in class nl.talsmasoftware.umldoclet.uml.ClassDiagram
 
addChild(UMLNode) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters
 
addChild(UMLNode) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
addHttpParam(URI, String, String) - Static method in class nl.talsmasoftware.umldoclet.util.UriUtils
This method adds a query parameter to an existing URI and takes care of proper encoding etc.
addNote(String) - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
addPackageDependency(String, String) - Method in class nl.talsmasoftware.umldoclet.uml.DependencyDiagram
 
addParameter(String, TypeName) - Method in class nl.talsmasoftware.umldoclet.uml.Method
Add a new parameter to this method.
addPathComponent(URI, String) - Static method in class nl.talsmasoftware.umldoclet.util.UriUtils
This method adds a 'component' to the path of an URI.
AFTER_TYPE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames
Render the method parameter type first, followed by its name.
ANNOTATION - Enum constant in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
append(char) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
append(CharSequence) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
append(CharSequence, int, int) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 

B

BEFORE_TYPE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames
Render the method parameter name first, followed by its type.

C

canonical() - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
charAt(int) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
CLASS - Enum constant in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
ClassDiagram - Class in nl.talsmasoftware.umldoclet.uml
UML diagram for a single class.
ClassDiagram(Configuration, Type) - Constructor for class nl.talsmasoftware.umldoclet.uml.ClassDiagram
 
close() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
close() - Method in class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
Delegates the close operation to all delegates and merges any occurred exceptions into a single IOException.
Configuration - Interface in nl.talsmasoftware.umldoclet.configuration
Configuration that influences how UML should be rendered.
contains(TypeName) - Method in class nl.talsmasoftware.umldoclet.uml.Namespace
 
contains(TypeName) - Method in class nl.talsmasoftware.umldoclet.uml.Reference
Returns whether or not this reference contains the requested type.
createClassDiagram(TypeElement) - Method in class nl.talsmasoftware.umldoclet.javadoc.UMLFactory
 
createPackageDiagram(PackageElement) - Method in class nl.talsmasoftware.umldoclet.javadoc.UMLFactory
 
customPlantumlDirectives() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
Custom directives to include in rendered PlantUML diagram sources.
customPlantumlDirectives() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 

D

debug(Object, Object...) - Method in interface nl.talsmasoftware.umldoclet.logging.Logger
 
DEBUG_CANNOT_READ_ELEMENT_LIST - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DEBUG_CONFIGURED_IMAGE_FORMATS - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DEBUG_LIVE_PACKAGE_URL_NOT_FOUND - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DEBUG_PACKAGE_VISITED_BUT_UNDOCUMENTED - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DEBUG_REPLACING_BY - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DEBUG_SKIPPING_FILE - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
decrease() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
DEFAULT - Static variable in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
The default indentation is four spaces, initially at level 0.
delegateDocletName() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
delegateDocletName() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
delegates - Variable in class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
The list of delegate writers to write to.
DelegatingWriter - Class in nl.talsmasoftware.umldoclet.rendering.writers
Base implementation that delegates writing to one or more delegate writers.
DelegatingWriter(Writer...) - Constructor for class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
Constructor.
DependenciesElementScanner - Class in nl.talsmasoftware.umldoclet.javadoc.dependencies
JavaDoc ElementScanner to detect dependencies.
DependenciesElementScanner(DocletEnvironment, Configuration) - Constructor for class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Constructor to create a new package dependencies scanner.
DependencyDiagram - Class in nl.talsmasoftware.umldoclet.uml
UML diagram representing the dependencies between the documented Java packages.
DependencyDiagram(Configuration, String) - Constructor for class nl.talsmasoftware.umldoclet.uml.DependencyDiagram
 
deprecated() - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
destinationDirectory() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
destinationDirectory() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
detectCycles(Iterable<PackageDependency>) - Static method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependencyCycle
Detect cycles in a collection of dependencies.
detectFrom(Type) - Static method in class nl.talsmasoftware.umldoclet.uml.util.JavaBeanProperty
This method detects the JavaBean properties from the uml Type model of a Java class.
Diagram - Class in nl.talsmasoftware.umldoclet.uml
Abstract class corresponding to a single UML diagram.
Diagram(Configuration) - Constructor for class nl.talsmasoftware.umldoclet.uml.Diagram
 
directory() - Method in interface nl.talsmasoftware.umldoclet.configuration.ImageConfig
 
DOCLET_COPYRIGHT - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DOCLET_UML_FOOTER - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DOCLET_VERSION - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
DocletConfig - Class in nl.talsmasoftware.umldoclet.javadoc
 
DocletConfig() - Constructor for class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 

E

ensureParentDir(File) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
Ensure that the parent directory exists for the specified file.
ENUM - Enum constant in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
EPS - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
Value to indicate UML diagrams must be rendered as EPS (Encapsulated Postscript) images.
equals(Object) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
Equal implementation based on the PackageDependency.fromPackage and PackageDependency.toPackage values.
equals(Object) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
Whether the other object represents the exact same indentation object.
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.Method
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.Namespace
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.Reference.Side
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.TypeName
 
equals(Object) - Method in class nl.talsmasoftware.umldoclet.uml.TypeName.Variable
 
error(Message, Object...) - Method in interface nl.talsmasoftware.umldoclet.logging.Logger
 
ERROR_UNANTICIPATED_ERROR_GENERATING_DIAGRAMS - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
ERROR_UNANTICIPATED_ERROR_GENERATING_UML - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
ERROR_UNANTICIPATED_ERROR_POSTPROCESSING_HTML - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
ERROR_UNSUPPORTED_DELEGATE_DOCLET - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
excludedPackageDependencies() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
excludedPackageDependencies() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
excludedTypeReferences() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
excludedTypeReferences() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
extendsBound(String, TypeName) - Static method in class nl.talsmasoftware.umldoclet.uml.TypeName.Variable
 

F

failOnCyclicPackageDependencies() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
failOnCyclicPackageDependencies() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
Field - Class in nl.talsmasoftware.umldoclet.uml
Model object for a Field in an UML class.
Field(Type, String, TypeName) - Constructor for class nl.talsmasoftware.umldoclet.uml.Field
 
FieldConfig - Interface in nl.talsmasoftware.umldoclet.configuration
Influences how Fields are rendered in the UML.
fields() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
fields() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
fileNameOf(String) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
Shortcut implementation that determines the substring after the last Windows or *nix path separator.
FileUtils - Class in nl.talsmasoftware.umldoclet.util
Contains static utility methods for files.
findParent(Class<U>) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
flush() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
flush() - Method in class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
Delegates the flush operation to all delegates and merges any occurred exceptions into a single IOException.
formats() - Method in interface nl.talsmasoftware.umldoclet.configuration.ImageConfig
By default SVG images will be generated because they are a lot smaller than for instance PNG images and they can include links to Javadoc HTML pages.
forPackage(Namespace) - Static method in class nl.talsmasoftware.umldoclet.uml.Link
 
forType(Type) - Static method in class nl.talsmasoftware.umldoclet.uml.Link
 
from - Variable in class nl.talsmasoftware.umldoclet.uml.Reference
 
from(String, String) - Static method in class nl.talsmasoftware.umldoclet.uml.Reference.Side
 
fromPackage - Variable in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
The qualified name of the depending package.

G

get(int) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependencyCycle
 
getBuffer() - Method in class nl.talsmasoftware.umldoclet.rendering.writers.StringBufferingWriter
A buffer of the written characters.
getChildren() - Method in class nl.talsmasoftware.umldoclet.uml.DependencyDiagram
 
getChildren() - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
getChildren(Class<T>) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
Returns all children that are an instance of a particular type.
getClassfication() - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
getConfiguration() - Method in class nl.talsmasoftware.umldoclet.uml.Diagram
 
getConfiguration() - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
getDelegate() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
getGenerics() - Method in class nl.talsmasoftware.umldoclet.uml.TypeName
 
getIndentation() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
getName() - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
getName() - Method in class nl.talsmasoftware.umldoclet.UMLDoclet
 
getPackagename() - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
getParent() - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
getPlantUmlFile() - Method in class nl.talsmasoftware.umldoclet.uml.ClassDiagram
 
getPlantUmlFile() - Method in class nl.talsmasoftware.umldoclet.uml.DependencyDiagram
 
getPlantUmlFile() - Method in class nl.talsmasoftware.umldoclet.uml.Diagram
Determine the physical file location for the plantuml output.
getPlantUmlFile() - Method in class nl.talsmasoftware.umldoclet.uml.PackageDiagram
 
getSupportedOptions() - Method in class nl.talsmasoftware.umldoclet.UMLDoclet
Returns all supported options.
getType() - Method in class nl.talsmasoftware.umldoclet.uml.ClassDiagram
 
getVisibility() - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 

H

hasExtension(Object, String) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.Method
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.Namespace
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.Reference.Side
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
hashCode() - Method in class nl.talsmasoftware.umldoclet.uml.TypeName
 
htmlCharset() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
The HTML character set is determined the same way the Standard doclet uses, as we delegate the initial rendering to it: use the "-docencoding" if set, otherwise the source encoding ("-encoding") finally, if no encodings are specified at all, the default platform encoding is used as implicit fallback
htmlCharset() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
HtmlPostprocessor - Class in nl.talsmasoftware.umldoclet.html
Postprocesses the HTML output from the standard doclet to add UML diagrams.
HtmlPostprocessor(Configuration) - Constructor for class nl.talsmasoftware.umldoclet.html.HtmlPostprocessor
 

I

ImageConfig - Interface in nl.talsmasoftware.umldoclet.configuration
Configuration relating to the images that are generated.
ImageConfig.Format - Enum Class in nl.talsmasoftware.umldoclet.configuration
Supported image formats.
images() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
images() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
include(Visibility) - Method in interface nl.talsmasoftware.umldoclet.configuration.FieldConfig
Return whether to include fields with the specified Visibility into the UML diagram.
include(Visibility) - Method in interface nl.talsmasoftware.umldoclet.configuration.MethodConfig
Return whether the method with specified visibility should be included in the UML diagram.
increase() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
indent() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
indent() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
indentation() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
indentation() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
Indentation - Class in nl.talsmasoftware.umldoclet.rendering.indent
Type to capture the indentation as an immutable type containing a pre-filled buffer to quickly be written.
IndentingPrintWriter - Class in nl.talsmasoftware.umldoclet.rendering.indent
PrintWriter implementation that will indent each new line with a specified number of whitespace characters.
IndentingPrintWriter(Appendable, Indentation) - Constructor for class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
IndentingWriter - Class in nl.talsmasoftware.umldoclet.rendering.indent
Writer implementation that will indent each new line with a specified number of whitespace characters (four by default).
IndentingWriter(Appendable, Indentation) - Constructor for class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
info(Message, Object...) - Method in interface nl.talsmasoftware.umldoclet.logging.Logger
 
INFO_ADD_DIAGRAM_TO_FILE - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
INFO_GENERATING_FILE - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
init(Locale, Reporter) - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
init(Locale, Reporter) - Method in class nl.talsmasoftware.umldoclet.UMLDoclet
Initializes the Locale and Reporter to be used by this doclet.
INTERFACE - Enum constant in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
isAbstract - Variable in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
isDeprecated - Variable in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
isSelfReference() - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
isStatic - Variable in class nl.talsmasoftware.umldoclet.uml.TypeMember
 

J

javaBeanPropertiesAsFields() - Method in interface nl.talsmasoftware.umldoclet.configuration.MethodConfig
Whether JavaBean property accessor methods such as getXyz(), isXyz(), setXyz(Xyz xyz) should be rendered as Fields in UML.
javaBeanPropertiesAsFieldsPostProcessor() - Method in class nl.talsmasoftware.umldoclet.uml.util.UmlPostProcessors
A post-processor for a uml Type to replace getter and setter methods into fields.
JavaBeanProperty - Class in nl.talsmasoftware.umldoclet.uml.util
Class representing a property of a Java Bean.

L

length() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
Link - Class in nl.talsmasoftware.umldoclet.uml
Class for rendering links in the generated UML
linkFrom(String) - Static method in class nl.talsmasoftware.umldoclet.uml.Link
Sets the base path where relative links should be rendered from.
localize(Message, Object...) - Method in interface nl.talsmasoftware.umldoclet.logging.Logger
 
logger() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
Custom logger implementation that only supports fixed messages.
logger() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
Logger - Interface in nl.talsmasoftware.umldoclet.logging
Basic Logger interface to avoid dependencies on the jdk.logger module or Slf4J.

M

mergeOptionsWith(Set<? extends Doclet.Option>) - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
Message - Enum Class in nl.talsmasoftware.umldoclet.logging
The resource messages used by the doclet.
Method - Class in nl.talsmasoftware.umldoclet.uml
 
Method(Type, String, TypeName) - Constructor for class nl.talsmasoftware.umldoclet.uml.Method
 
MethodConfig - Interface in nl.talsmasoftware.umldoclet.configuration
Influences how Methods are rendered in the UML.
MethodConfig.ParamNames - Enum Class in nl.talsmasoftware.umldoclet.configuration
How parameter names must be rendered.
methods() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
methods() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 

N

name - Variable in class nl.talsmasoftware.umldoclet.uml.Namespace
 
name - Variable in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
Namespace - Class in nl.talsmasoftware.umldoclet.uml
UML namespace
Namespace(UMLNode, String) - Constructor for class nl.talsmasoftware.umldoclet.uml.Namespace
 
newline() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
nl.talsmasoftware.umldoclet - package nl.talsmasoftware.umldoclet
Doclet for the JavaDoc tool that generates UML diagrams from the code.
nl.talsmasoftware.umldoclet.configuration - package nl.talsmasoftware.umldoclet.configuration
Configuration guiding the details the way UML is generated.
nl.talsmasoftware.umldoclet.html - package nl.talsmasoftware.umldoclet.html
Package dedicated to the HTML postprocessing required to embed UML diagrams into the documentation.
nl.talsmasoftware.umldoclet.javadoc - package nl.talsmasoftware.umldoclet.javadoc
Package for all Javadoc specific code in the doclet.
nl.talsmasoftware.umldoclet.javadoc.dependencies - package nl.talsmasoftware.umldoclet.javadoc.dependencies
Package using collected Javadoc data to detect package dependencies and any cycles in them.
nl.talsmasoftware.umldoclet.logging - package nl.talsmasoftware.umldoclet.logging
Package containing an internal minimal logging abstraction that can be easily mapped to common logging frameworks (such as java.util.logging or Slf4J) but also to the Javadoc Reporter.
nl.talsmasoftware.umldoclet.rendering.indent - package nl.talsmasoftware.umldoclet.rendering.indent
Package defining an Indentation concept.
nl.talsmasoftware.umldoclet.rendering.writers - package nl.talsmasoftware.umldoclet.rendering.writers
Package for convenience Writer implementations.
nl.talsmasoftware.umldoclet.uml - package nl.talsmasoftware.umldoclet.uml
Package containing the model to generate PlantUML diagrams with.
nl.talsmasoftware.umldoclet.uml.util - package nl.talsmasoftware.umldoclet.uml.util
Utility UML functionality.
nl.talsmasoftware.umldoclet.util - package nl.talsmasoftware.umldoclet.util
Package for common utilities not otherwise related to the core UML doclet.
NONE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames
Omit names of method parameters.
NONE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Omit the type name.
NONE - Static variable in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
A reusable constant for no indentation at all (even after calls to Indentation.increase()).
notes - Variable in class nl.talsmasoftware.umldoclet.uml.Reference
 

O

of(TypeName) - Static method in class nl.talsmasoftware.umldoclet.uml.TypeName.Array
 
openReaderTo(String, URI, String) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
Opens a reader to the specified URI.

P

PACKAGE_PRIVATE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
The visibility corresponding with the Java default Modifier.
PackageDependency - Class in nl.talsmasoftware.umldoclet.javadoc.dependencies
Package dependency.
PackageDependency(String, String) - Constructor for class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
Create a new package dependency object.
PackageDependencyCycle - Class in nl.talsmasoftware.umldoclet.javadoc.dependencies
A cycle of dependencies.
PackageDependencyCycle(PackageDependency...) - Constructor for class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependencyCycle
Create a new dependency cycle object.
PackageDiagram - Class in nl.talsmasoftware.umldoclet.uml
 
PackageDiagram(Configuration, String) - Constructor for class nl.talsmasoftware.umldoclet.uml.PackageDiagram
 
Parameters - Class in nl.talsmasoftware.umldoclet.uml
 
Parameters(UMLNode) - Constructor for class nl.talsmasoftware.umldoclet.uml.Parameters
 
Parameters.Parameter - Class in nl.talsmasoftware.umldoclet.uml
 
paramNames() - Method in interface nl.talsmasoftware.umldoclet.configuration.MethodConfig
How method parameter names must be rendered.
paramTypes() - Method in interface nl.talsmasoftware.umldoclet.configuration.MethodConfig
How parameter types must be rendered.
PLANTUML_COPYRIGHT - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
PNG - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
Value to indicate UML diagrams must be rendered as PNG (Portable Network Graphics) images.
postProcessHtml() - Method in class nl.talsmasoftware.umldoclet.html.HtmlPostprocessor
 
PRIVATE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
The visibility corresponding with the Java private modifier.
PROTECTED - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
The visibility corresponding with the Java protected modifier.
PUBLIC - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
The visibility corresponding with the Java public modifier.

Q

qualified - Variable in class nl.talsmasoftware.umldoclet.uml.TypeName
 
QUALIFIED - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Use the qualified type name.
QUALIFIED_GENERICS - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Use the qualified type name, also for its generic type variables.

R

Reference - Class in nl.talsmasoftware.umldoclet.uml
Reference between two types.
Reference(Reference.Side, String, Reference.Side, String...) - Constructor for class nl.talsmasoftware.umldoclet.uml.Reference
 
Reference.Side - Class in nl.talsmasoftware.umldoclet.uml
 
relativePath(File, File) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
Returns the relative path from one file to another.
removeChildren(Predicate<? super UMLNode>) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
render() - Method in class nl.talsmasoftware.umldoclet.uml.Diagram
 
renderPumlFile() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
 
renderPumlFile() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
resolveExternalLinkToType(String, String) - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
Resolves an external link to the specified type.
resolveExternalLinkToType(String, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
returnType() - Method in interface nl.talsmasoftware.umldoclet.configuration.MethodConfig
How method return types must be rendered.
run(DocletEnvironment) - Method in class nl.talsmasoftware.umldoclet.UMLDoclet
Perform the main doclet functionality, processing all included elements.

S

setIncludePackagename(boolean) - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
setParent(UMLNode) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
 
setVisibility(Visibility) - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
simple - Variable in class nl.talsmasoftware.umldoclet.uml.TypeName
 
SIMPLE - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Use the simple type name without the containing package.
size() - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependencyCycle
 
spaces(int, int) - Static method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
Returns an indentation of width spaces, initially indented at width * level spaces.
StringBufferingWriter - Class in nl.talsmasoftware.umldoclet.rendering.writers
Delegates to another Writer retaining a StringBuffer of all written characters.
StringBufferingWriter(Writer) - Constructor for class nl.talsmasoftware.umldoclet.rendering.writers.StringBufferingWriter
Constructor.
subSequence(int, int) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
superBound(String, TypeName) - Static method in class nl.talsmasoftware.umldoclet.uml.TypeName.Variable
 
SVG - Enum constant in enum class nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
Value to indicate UML diagrams must be rendered as SVG (scalable vector graphics) images.

T

tabs(int) - Static method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
Returns an indentation of level tabs, increasing or decreasing by one tab at a time.
to - Variable in class nl.talsmasoftware.umldoclet.uml.Reference
 
to(String, String) - Static method in class nl.talsmasoftware.umldoclet.uml.Reference.Side
 
toPackage - Variable in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
The qualified name of the depended-upon package.
toString() - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependency
 
toString() - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.PackageDependencyCycle
 
toString() - Method in enum class nl.talsmasoftware.umldoclet.logging.Message
 
toString() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.Indentation
 
toString() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
toString() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
toString() - Method in class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
 
toString() - Method in class nl.talsmasoftware.umldoclet.rendering.writers.StringBufferingWriter
 
toString() - Method in class nl.talsmasoftware.umldoclet.uml.Diagram
 
toString() - Method in class nl.talsmasoftware.umldoclet.uml.Reference.Side
 
toString() - Method in class nl.talsmasoftware.umldoclet.uml.TypeName
 
toString() - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
Renders the entire content of this renderer and returns it as a String value.
toString(Locale) - Method in enum class nl.talsmasoftware.umldoclet.logging.Message
 
toUml() - Method in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
 
toUml(TypeDisplay, Namespace) - Method in class nl.talsmasoftware.umldoclet.uml.TypeName.Array
 
toUml(TypeDisplay, Namespace) - Method in class nl.talsmasoftware.umldoclet.uml.TypeName
 
toUml(TypeDisplay, Namespace) - Method in class nl.talsmasoftware.umldoclet.uml.TypeName.Variable
 
type - Variable in class nl.talsmasoftware.umldoclet.uml.Reference
 
type - Variable in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
Type - Class in nl.talsmasoftware.umldoclet.uml
 
Type(Namespace, Type.Classification, TypeName) - Constructor for class nl.talsmasoftware.umldoclet.uml.Type
 
Type.Classification - Enum Class in nl.talsmasoftware.umldoclet.uml
Classification of a UML Type.
typeDisplay() - Method in interface nl.talsmasoftware.umldoclet.configuration.FieldConfig
How to display the type of the field in the UML diagram (if included).
TypeDisplay - Enum Class in nl.talsmasoftware.umldoclet.configuration
The way in which a type is rendered in the resulting UML.
TypeMember - Class in nl.talsmasoftware.umldoclet.uml
Model object for a Field or Method in an UML class.
TypeMember(Type, String, TypeName) - Constructor for class nl.talsmasoftware.umldoclet.uml.TypeMember
 
TypeName - Class in nl.talsmasoftware.umldoclet.uml
Class representing a type name.
TypeName(String, String, TypeName...) - Constructor for class nl.talsmasoftware.umldoclet.uml.TypeName
 
TypeName.Array - Class in nl.talsmasoftware.umldoclet.uml
 
TypeName.Variable - Class in nl.talsmasoftware.umldoclet.uml
 

U

umlCharset() - Method in interface nl.talsmasoftware.umldoclet.configuration.Configuration
The UML character set can be explicitly configured with the "-umlEncoding" option.
umlCharset() - Method in class nl.talsmasoftware.umldoclet.javadoc.DocletConfig
 
UMLDoclet - Class in nl.talsmasoftware.umldoclet
UML doclet that generates PlantUML class diagrams from your java code just as easily as creating proper JavaDoc comments.
It actually extends JavaDoc's StandardDoclet doclet to generate the regular HTML documentation.
UMLDoclet() - Constructor for class nl.talsmasoftware.umldoclet.UMLDoclet
Default constructor, as required by Doclet specification.
UMLFactory - Class in nl.talsmasoftware.umldoclet.javadoc
One big factory to produce UML from analyzed Javadoc elements.
UMLFactory(Configuration, DocletEnvironment) - Constructor for class nl.talsmasoftware.umldoclet.javadoc.UMLFactory
 
UMLNode - Class in nl.talsmasoftware.umldoclet.uml
Part of an UML diagram that can render itself to the diagram by writing to an indenting writer.
UMLNode(UMLNode) - Constructor for class nl.talsmasoftware.umldoclet.uml.UMLNode
 
UmlPostProcessors - Class in nl.talsmasoftware.umldoclet.uml.util
Utility class providing postprocessing functionality for generated UML models.
UmlPostProcessors() - Constructor for class nl.talsmasoftware.umldoclet.uml.util.UmlPostProcessors
 
unindent() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
unindent() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
updateGenericTypeVariables(TypeName) - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
UriUtils - Class in nl.talsmasoftware.umldoclet.util
Utility class for manipulating URI's

V

valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.logging.Message
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
Returns the enum constant of this class with the specified name.
values() - Static method in enum class nl.talsmasoftware.umldoclet.configuration.ImageConfig.Format
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nl.talsmasoftware.umldoclet.configuration.MethodConfig.ParamNames
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nl.talsmasoftware.umldoclet.configuration.TypeDisplay
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nl.talsmasoftware.umldoclet.configuration.Visibility
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nl.talsmasoftware.umldoclet.logging.Message
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nl.talsmasoftware.umldoclet.uml.Type.Classification
Returns an array containing the constants of this enum class, in the order they are declared.
varargs(boolean) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters
 
Visibility - Enum Class in nl.talsmasoftware.umldoclet.configuration
The visibility values for classes, methods and fields.
visitExecutable(ExecutableElement, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Visit an executable element (method, constructor or initializer) to add its package dependency to the current set.
visitPackage(PackageElement, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Visit a package to evalutate all dependencies from its elements to other packages.
visitType(TypeElement, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Visit a type element to add their package dependencies to the current set.
visitTypeParameter(TypeParameterElement, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Visit a type parameter element (a generic) to add its package dependency to the current set.
visitUnknown(Element, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Overrides visiting any unknown element.
visitVariable(VariableElement, String) - Method in class nl.talsmasoftware.umldoclet.javadoc.dependencies.DependenciesElementScanner
Visit a variable element (field, constant or method parameter) to add its package dependency to the current set.

W

warn(Message, Object...) - Method in interface nl.talsmasoftware.umldoclet.logging.Logger
 
WARNING_CANNOT_READ_PACKAGE_LIST - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
WARNING_PACKAGE_DEPENDENCY_CYCLES - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
WARNING_UNKNOWN_VISIBILITY - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
WARNING_UNRECOGNIZED_IMAGE_FORMAT - Enum constant in enum class nl.talsmasoftware.umldoclet.logging.Message
 
whitespace() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
 
whitespace() - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
Makes sure there is at least one whitespace character between the last charater and the next.
withIndentation(Indentation) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
Returns an indenting writer with the new indentation.
withoutExtension(String) - Static method in class nl.talsmasoftware.umldoclet.util.FileUtils
 
wrap(Appendable, Indentation) - Static method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingPrintWriter
Returns an indenting printwriter around the given delegate.
wrap(Appendable, Indentation) - Static method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
Returns an indenting writer around the given delegate.
If the delegate writer is already an indenting writer, it will simply be returned with the specified indentation.
If the delegate writer is not yet an indending writer, a new indenting writer class will be created to wrap the delegate using the specified indentation.
write(char[], int, int) - Method in class nl.talsmasoftware.umldoclet.rendering.indent.IndentingWriter
 
write(char[], int, int) - Method in class nl.talsmasoftware.umldoclet.rendering.writers.DelegatingWriter
Delegates the write operation to all delegates and merges any occurred exceptions into a single IOException.
writeChildrenTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.ClassDiagram
 
writeChildrenTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters
 
writeChildrenTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
writeChildrenTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
Helper method to write all children to the specified output.
writeChildrenTo(IndentingPrintWriter) - Method in class nl.talsmasoftware.umldoclet.uml.DependencyDiagram
 
writeParametersTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Method
 
writeParametersTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Diagram
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Field
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Link
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Method
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Namespace
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters.Parameter
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Parameters
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Reference
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Type
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
writeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.UMLNode
Renders this object to the given indenting output.
writeTypeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Field
 
writeTypeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.Method
 
writeTypeTo(IPW) - Method in class nl.talsmasoftware.umldoclet.uml.TypeMember
 
A B C D E F G H I J L M N O P Q R S T U V W 
All Classes|All Packages|Serialized Form