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

A

addRelation(RelationType, RelationDirection) - Method in class org.umlgraph.doclet.RelationPattern

Adds, eventually merging, a direction for the specified relation type

annotations() - Method in class org.umlgraph.doclet.WrappedClassDoc

asAnnotatedType() - Method in class org.umlgraph.doclet.WrappedClassDoc

asAnnotationTypeDoc() - Method in class org.umlgraph.doclet.WrappedClassDoc

asClassDoc() - Method in class org.umlgraph.doclet.WrappedClassDoc

asParameterizedType() - Method in class org.umlgraph.doclet.WrappedClassDoc

asTypeVariable() - Method in class org.umlgraph.doclet.WrappedClassDoc

asWildcardType() - Method in class org.umlgraph.doclet.WrappedClassDoc

B

buildGraph(RootDoc, OptionProvider, Doc) - Static method in class org.umlgraph.doclet.UmlGraph

Builds and outputs a single graph according to the view overrides

buildOptions(RootDoc) - Static method in class org.umlgraph.doclet.UmlGraph

Creates the base Options object.

buildViews(Options, RootDoc, RootDoc) - Static method in class org.umlgraph.doclet.UmlGraph

Builds the views according to the parameters on the command line

C

classes() - Method in class org.umlgraph.doclet.WrappedRootDoc

ClassMatcher - Interface in org.umlgraph.doclet

A ClassMatcher is used to check if a class definition matches a specific condition.

classNamed(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

clone() - Method in class org.umlgraph.doclet.Options

commentText() - Method in class org.umlgraph.doclet.WrappedClassDoc

commentText() - Method in class org.umlgraph.doclet.WrappedRootDoc

compareTo(Object) - Method in class org.umlgraph.doclet.WrappedClassDoc

compareTo(Object) - Method in class org.umlgraph.doclet.WrappedRootDoc

constructors() - Method in class org.umlgraph.doclet.WrappedClassDoc

constructors(boolean) - Method in class org.umlgraph.doclet.WrappedClassDoc

containingClass() - Method in class org.umlgraph.doclet.WrappedClassDoc

containingPackage() - Method in class org.umlgraph.doclet.WrappedClassDoc

contains(RelationDirection) - Method in enum org.umlgraph.doclet.RelationDirection

Returns true if this direction "contains" the specified one, that is, either it's equal to it, or this direction is RelationDirection.BOTH

ContextMatcher - Class in org.umlgraph.doclet

Matches classes that are directly connected to one of the classes matched by the regual expression specified.

ContextMatcher(RootDoc, Pattern, Options, boolean) - Constructor for class org.umlgraph.doclet.ContextMatcher

Builds the context matcher

ContextView - Class in org.umlgraph.doclet

A view designed for UMLDoc, filters out everything that it's not directly connected to the center class of the context.

ContextView(String, ClassDoc, RootDoc, Options) - Constructor for class org.umlgraph.doclet.ContextView

D

DEFAULT_EXTERNAL_APIDOC - Static variable in class org.umlgraph.doclet.Options

definesSerializableFields() - Method in class org.umlgraph.doclet.WrappedClassDoc

dimension() - Method in class org.umlgraph.doclet.WrappedClassDoc

E

enumConstants() - Method in class org.umlgraph.doclet.WrappedClassDoc

F

fields() - Method in class org.umlgraph.doclet.WrappedClassDoc

fields(boolean) - Method in class org.umlgraph.doclet.WrappedClassDoc

findClass(String) - Method in class org.umlgraph.doclet.WrappedClassDoc

firstSentenceTags() - Method in class org.umlgraph.doclet.WrappedClassDoc

firstSentenceTags() - Method in class org.umlgraph.doclet.WrappedRootDoc

G

get(ProgramElementDoc) - Static method in enum org.umlgraph.doclet.Visibility

getApiDocRoot(String) - Method in class org.umlgraph.doclet.Options

Returns the appropriate URL "root" for an external class name.

getCommentOptions() - Static method in class org.umlgraph.doclet.UmlGraph

getDisplayName() - Method in class org.umlgraph.doclet.ContextView

getDisplayName() - Method in interface org.umlgraph.doclet.OptionProvider

Returns user displayable name for this option provider.

getDisplayName() - Method in class org.umlgraph.doclet.Options

getDisplayName() - Method in class org.umlgraph.doclet.PackageView

getDisplayName() - Method in class org.umlgraph.doclet.View

getElementType() - Method in class org.umlgraph.doclet.WrappedClassDoc

getGlobalOptions() - Method in class org.umlgraph.doclet.ContextView

getGlobalOptions() - Method in interface org.umlgraph.doclet.OptionProvider

Returns the global options (the class independent definition)

getGlobalOptions() - Method in class org.umlgraph.doclet.Options

getGlobalOptions() - Method in class org.umlgraph.doclet.PackageView

getGlobalOptions() - Method in class org.umlgraph.doclet.View

getOptionsFor(ClassDoc) - Method in class org.umlgraph.doclet.ContextView

getOptionsFor(ClassDoc) - Method in interface org.umlgraph.doclet.OptionProvider

Returns the options for the specified class.

getOptionsFor(ClassDoc) - Method in class org.umlgraph.doclet.Options

getOptionsFor(ClassDoc) - Method in class org.umlgraph.doclet.PackageView

getOptionsFor(ClassDoc) - Method in class org.umlgraph.doclet.View

getRawCommentText() - Method in class org.umlgraph.doclet.WrappedClassDoc

getRawCommentText() - Method in class org.umlgraph.doclet.WrappedRootDoc

graphvizAttribute() - Method in class org.umlgraph.doclet.Shape

Return the GraphViz shape name corresponding to the shape

I

importedClasses() - Method in class org.umlgraph.doclet.WrappedClassDoc

Deprecated.

importedPackages() - Method in class org.umlgraph.doclet.WrappedClassDoc

Deprecated.

inlineTags() - Method in class org.umlgraph.doclet.WrappedClassDoc

inlineTags() - Method in class org.umlgraph.doclet.WrappedRootDoc

innerClasses() - Method in class org.umlgraph.doclet.WrappedClassDoc

innerClasses(boolean) - Method in class org.umlgraph.doclet.WrappedClassDoc

InterfaceMatcher - Class in org.umlgraph.doclet

Matches every class that implements (directly or indirectly) an interfaces matched by regular expression provided.

InterfaceMatcher(RootDoc, Pattern) - Constructor for class org.umlgraph.doclet.InterfaceMatcher

interfaces() - Method in class org.umlgraph.doclet.WrappedClassDoc

interfaceTypes() - Method in class org.umlgraph.doclet.WrappedClassDoc

inverse() - Method in enum org.umlgraph.doclet.RelationDirection

Inverts the direction of the relation.

isAbstract() - Method in class org.umlgraph.doclet.WrappedClassDoc

isAnnotationType() - Method in class org.umlgraph.doclet.WrappedClassDoc

isAnnotationType() - Method in class org.umlgraph.doclet.WrappedRootDoc

isAnnotationTypeElement() - Method in class org.umlgraph.doclet.WrappedClassDoc

isAnnotationTypeElement() - Method in class org.umlgraph.doclet.WrappedRootDoc

isClass() - Method in class org.umlgraph.doclet.WrappedClassDoc

isClass() - Method in class org.umlgraph.doclet.WrappedRootDoc

isConstructor() - Method in class org.umlgraph.doclet.WrappedClassDoc

isConstructor() - Method in class org.umlgraph.doclet.WrappedRootDoc

isEnum() - Method in class org.umlgraph.doclet.WrappedClassDoc

isEnum() - Method in class org.umlgraph.doclet.WrappedRootDoc

isEnumConstant() - Method in class org.umlgraph.doclet.WrappedClassDoc

isEnumConstant() - Method in class org.umlgraph.doclet.WrappedRootDoc

isError() - Method in class org.umlgraph.doclet.WrappedClassDoc

isError() - Method in class org.umlgraph.doclet.WrappedRootDoc

isException() - Method in class org.umlgraph.doclet.WrappedClassDoc

isException() - Method in class org.umlgraph.doclet.WrappedRootDoc

isExternalizable() - Method in class org.umlgraph.doclet.WrappedClassDoc

isField() - Method in class org.umlgraph.doclet.WrappedClassDoc

isField() - Method in class org.umlgraph.doclet.WrappedRootDoc

isFinal() - Method in class org.umlgraph.doclet.WrappedClassDoc

isIncluded() - Method in class org.umlgraph.doclet.WrappedClassDoc

isIncluded() - Method in class org.umlgraph.doclet.WrappedRootDoc

isInterface() - Method in class org.umlgraph.doclet.WrappedClassDoc

isInterface() - Method in class org.umlgraph.doclet.WrappedRootDoc

isMethod() - Method in class org.umlgraph.doclet.WrappedClassDoc

isMethod() - Method in class org.umlgraph.doclet.WrappedRootDoc

isOrdinaryClass() - Method in class org.umlgraph.doclet.WrappedClassDoc

isOrdinaryClass() - Method in class org.umlgraph.doclet.WrappedRootDoc

isPackagePrivate() - Method in class org.umlgraph.doclet.WrappedClassDoc

isPrimitive() - Method in class org.umlgraph.doclet.WrappedClassDoc

isPrivate() - Method in class org.umlgraph.doclet.WrappedClassDoc

isProtected() - Method in class org.umlgraph.doclet.WrappedClassDoc

isPublic() - Method in class org.umlgraph.doclet.WrappedClassDoc

isSerializable() - Method in class org.umlgraph.doclet.WrappedClassDoc

isStatic() - Method in class org.umlgraph.doclet.WrappedClassDoc

L

languageVersion() - Static method in class org.umlgraph.doclet.UmlGraph

Indicate the language version we support

languageVersion() - Static method in class org.umlgraph.doclet.UmlGraphDoc

Standand doclet entry

M

main(String[]) - Static method in class org.umlgraph.doclet.UmlGraph

matches(ClassDoc) - Method in interface org.umlgraph.doclet.ClassMatcher

Returns the options for the specified class.

matches(ClassDoc) - Method in class org.umlgraph.doclet.ContextMatcher

matches(ClassDoc) - Method in class org.umlgraph.doclet.InterfaceMatcher

matches(ClassDoc) - Method in class org.umlgraph.doclet.PackageMatcher

matches(ClassDoc) - Method in class org.umlgraph.doclet.PatternMatcher

matches(ClassDoc) - Method in class org.umlgraph.doclet.SubclassMatcher

matchesCollPackageExpression(String) - Method in class org.umlgraph.doclet.Options

Check if the supplied string matches an entity specified with the -hide parameter.

matchesHideExpression(String) - Method in class org.umlgraph.doclet.Options

Check if the supplied string matches an entity specified with the -hide parameter.

matchesOne(RelationPattern) - Method in class org.umlgraph.doclet.RelationPattern

Returns true if this patterns matches at least the direction of one of the relations in the other relation patterns.

methods() - Method in class org.umlgraph.doclet.WrappedClassDoc

methods(boolean) - Method in class org.umlgraph.doclet.WrappedClassDoc

modifiers() - Method in class org.umlgraph.doclet.WrappedClassDoc

modifierSpecifier() - Method in class org.umlgraph.doclet.WrappedClassDoc

N

name() - Method in class org.umlgraph.doclet.WrappedClassDoc

name() - Method in class org.umlgraph.doclet.WrappedRootDoc

O

optionLength(String) - Static method in class org.umlgraph.doclet.Options

Return the number of arguments associated with the specified option.

optionLength(String) - Static method in class org.umlgraph.doclet.UmlGraph

Option checking

optionLength(String) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Option check, forwards options to the standard doclet, if that one refuses them, they are sent to UmlGraph

OptionProvider - Interface in org.umlgraph.doclet

A factory class that builds Options object for general use or for a specific class

Options - Class in org.umlgraph.doclet

Represent the program options

options() - Method in class org.umlgraph.doclet.WrappedRootDoc

org.umlgraph.doclet - package org.umlgraph.doclet

outputDirectory - Variable in class org.umlgraph.doclet.Options

outputFileName - Variable in class org.umlgraph.doclet.Options

overrideForClass(Options, ClassDoc) - Method in class org.umlgraph.doclet.ContextView

overrideForClass(Options, ClassDoc) - Method in interface org.umlgraph.doclet.OptionProvider

Gets a base Options and applies the overrides for the specified class

overrideForClass(Options, ClassDoc) - Method in class org.umlgraph.doclet.Options

overrideForClass(Options, ClassDoc) - Method in class org.umlgraph.doclet.PackageView

overrideForClass(Options, ClassDoc) - Method in class org.umlgraph.doclet.View

P

packageDoc - Variable in class org.umlgraph.doclet.PackageMatcher

PackageMatcher - Class in org.umlgraph.doclet

PackageMatcher(PackageDoc) - Constructor for class org.umlgraph.doclet.PackageMatcher

packageNamed(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

PackageView - Class in org.umlgraph.doclet

A view designed for UMLDoc, filters out everything that it's not contained in the specified package.

PackageView(String, PackageDoc, RootDoc, OptionProvider) - Constructor for class org.umlgraph.doclet.PackageView

pattern - Variable in class org.umlgraph.doclet.InterfaceMatcher

pattern - Variable in class org.umlgraph.doclet.SubclassMatcher

PatternMatcher - Class in org.umlgraph.doclet

Matches classes performing a regular expression match on the qualified class name

PatternMatcher(Pattern) - Constructor for class org.umlgraph.doclet.PatternMatcher

position() - Method in class org.umlgraph.doclet.WrappedClassDoc

position() - Method in class org.umlgraph.doclet.WrappedRootDoc

printError(SourcePosition, String) - Method in class org.umlgraph.doclet.WrappedRootDoc

printError(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

printNotice(SourcePosition, String) - Method in class org.umlgraph.doclet.WrappedRootDoc

printNotice(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

printWarning(SourcePosition, String) - Method in class org.umlgraph.doclet.WrappedRootDoc

printWarning(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

Q

qualifiedName() - Method in class org.umlgraph.doclet.WrappedClassDoc

qualifiedTypeName() - Method in class org.umlgraph.doclet.WrappedClassDoc

R

RelationDirection - Enum in org.umlgraph.doclet

The possibile directions of a relation given a reference class (used in context diagrams)

RelationPattern - Class in org.umlgraph.doclet

A map from relation types to directions

RelationPattern(RelationDirection) - Constructor for class org.umlgraph.doclet.RelationPattern

Creates a new pattern using the same direction for every relation kind

RelationType - Enum in org.umlgraph.doclet

The type of relation that links two entities

root - Variable in class org.umlgraph.doclet.InterfaceMatcher

root - Variable in class org.umlgraph.doclet.SubclassMatcher

S

seeTags() - Method in class org.umlgraph.doclet.WrappedClassDoc

seeTags() - Method in class org.umlgraph.doclet.WrappedRootDoc

serializableFields() - Method in class org.umlgraph.doclet.WrappedClassDoc

serializationMethods() - Method in class org.umlgraph.doclet.WrappedClassDoc

setAll() - Method in class org.umlgraph.doclet.Options

Most complete output

setContextCenter(Pattern) - Method in class org.umlgraph.doclet.ContextMatcher

Can be used to setup a different pattern for this context matcher.

setContextCenter(ClassDoc) - Method in class org.umlgraph.doclet.ContextView

setOptions(String[][]) - Method in class org.umlgraph.doclet.Options

Set the options based on the command line parameters

setOptions(ClassDoc) - Method in class org.umlgraph.doclet.Options

Set the options based on the tag elements of the ClassDoc parameter

setRawCommentText(String) - Method in class org.umlgraph.doclet.WrappedClassDoc

setRawCommentText(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

Shape - Class in org.umlgraph.doclet

Properties of node shapes

Shape() - Constructor for class org.umlgraph.doclet.Shape

Construct a default (class) Shape

Shape(String) - Constructor for class org.umlgraph.doclet.Shape

Construct a Shape through the specified UMLGraph name

simpleTypeName() - Method in class org.umlgraph.doclet.WrappedClassDoc

specifiedClasses() - Method in class org.umlgraph.doclet.WrappedRootDoc

specifiedPackages() - Method in class org.umlgraph.doclet.WrappedRootDoc

start(RootDoc) - Static method in class org.umlgraph.doclet.UmlGraph

Entry point through javadoc

start(RootDoc) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Standard doclet entry point

SubclassMatcher - Class in org.umlgraph.doclet

Matches every class that extends (directly or indirectly) a class matched by the regular expression provided.

SubclassMatcher(RootDoc, Pattern) - Constructor for class org.umlgraph.doclet.SubclassMatcher

subclassOf(ClassDoc) - Method in class org.umlgraph.doclet.WrappedClassDoc

sum(RelationDirection) - Method in enum org.umlgraph.doclet.RelationDirection

Adds the current direction

superclass() - Method in class org.umlgraph.doclet.WrappedClassDoc

superclassType() - Method in class org.umlgraph.doclet.WrappedClassDoc

T

tags() - Method in class org.umlgraph.doclet.WrappedClassDoc

tags(String) - Method in class org.umlgraph.doclet.WrappedClassDoc

tags() - Method in class org.umlgraph.doclet.WrappedRootDoc

tags(String) - Method in class org.umlgraph.doclet.WrappedRootDoc

toString() - Method in class org.umlgraph.doclet.Options

toString() - Method in class org.umlgraph.doclet.WrappedClassDoc

typeName() - Method in class org.umlgraph.doclet.WrappedClassDoc

typeParameters() - Method in class org.umlgraph.doclet.WrappedClassDoc

typeParamTags() - Method in class org.umlgraph.doclet.WrappedClassDoc

U

UmlGraph - Class in org.umlgraph.doclet

Doclet API implementation

UmlGraph() - Constructor for class org.umlgraph.doclet.UmlGraph

UmlGraphDoc - Class in org.umlgraph.doclet

Chaining doclet that runs the standart Javadoc doclet first, and on success, runs the generation of dot files by UMLGraph

UmlGraphDoc() - Constructor for class org.umlgraph.doclet.UmlGraphDoc

UMLOptions - Class in org.umlgraph.doclet

Options for UMLGraph class diagram generation

UMLOptions() - Constructor for class org.umlgraph.doclet.UMLOptions

V

valueOf(String) - Static method in enum org.umlgraph.doclet.RelationDirection

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

valueOf(String) - Static method in enum org.umlgraph.doclet.RelationType

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

valueOf(String) - Static method in enum org.umlgraph.doclet.Visibility

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

values() - Static method in enum org.umlgraph.doclet.RelationDirection

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

values() - Static method in enum org.umlgraph.doclet.RelationType

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

values() - Static method in enum org.umlgraph.doclet.Visibility

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

View - Class in org.umlgraph.doclet

Contains the definition of a View.

View(RootDoc, ClassDoc, OptionProvider) - Constructor for class org.umlgraph.doclet.View

Builds a view given the class that contains its definition

Visibility - Enum in org.umlgraph.doclet

Enumerates the possible visibilities in a Java program.

W

WrappedClassDoc - Class in org.umlgraph.doclet

A ClassDoc wrapper that caches answer to the most common requests performed by UMLGraph, considerably improving the overall UMLDoc performance (ClassDoc computes most of the results for more fine grained information at each call).

WrappedClassDoc(ClassDoc) - Constructor for class org.umlgraph.doclet.WrappedClassDoc

WrappedRootDoc - Class in org.umlgraph.doclet

RootDoc wrapper that provides WrappedClassDoc instances instead of plain ClassDoc in order to optimize the overall performance of UMLDoc.

WrappedRootDoc(RootDoc) - Constructor for class org.umlgraph.doclet.WrappedRootDoc

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