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

A

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

Adds api doc roots from a link.

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

Adds api doc roots from an offline link.

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

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

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

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

Adds the specified class to the internal class graph along with its relations and depencies, eventually inferring them, according to the Options specified for this matcher

Align() - Constructor for enum org.umlgraph.doclet.ClassGraph.Align

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

allRelation(Options, RelationType, ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Print all relations for a given's class's tag

alterHtmlDocs(Options, String, String, String, String, Pattern, RootDoc) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Takes an HTML file, looks for the first instance of the specified insertion point, and inserts the diagram image reference and a client side map in that point.

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

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

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

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

associationMap - Static variable in class org.umlgraph.doclet.ClassGraph

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

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

attributes(Options, FieldDoc[]) - Method in class org.umlgraph.doclet.ClassGraph

Print the class's attributes fd

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

B

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

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

Builds and outputs a single graph according to the view overrides

buildMatcher(String) - Method in class org.umlgraph.doclet.View

Factory method that builds the appropriate matcher for @match tags

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

Creates the base Options object.

buildRelativePath(String, String) - Static method in class org.umlgraph.doclet.ClassGraph

buildView(RootDoc, ClassDoc, OptionProvider) - Static method in class org.umlgraph.doclet.UmlGraph

Builds a view along with its parent views, recursively

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

Builds the views according to the parameters on the command line

C

cd - Variable in class org.umlgraph.doclet.ClassGraph.FieldRelationInfo

cd - Variable in class org.umlgraph.doclet.ContextView

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

Return the cell border required for the shape

centerOptions - Variable in class org.umlgraph.doclet.ContextView

cg - Variable in class org.umlgraph.doclet.ContextMatcher

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

ClassGraph - Class in org.umlgraph.doclet

Class graph generation engine

ClassGraph(RootDoc, OptionProvider, Doc) - Constructor for class org.umlgraph.doclet.ClassGraph

Create a new ClassGraph.

ClassGraph.Align - Enum in org.umlgraph.doclet

ClassGraph.FieldRelationInfo - Class in org.umlgraph.doclet

ClassGraph.Font - Enum in org.umlgraph.doclet

ClassGraphHack(RootDoc, OptionProvider) - Constructor for class org.umlgraph.doclet.ContextMatcher.ClassGraphHack

ClassInfo - Class in org.umlgraph.doclet

Class's dot-compatible alias name (for fully qualified class names) and printed information

ClassInfo(boolean, boolean) - Constructor for class org.umlgraph.doclet.ClassInfo

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

classnames - Variable in class org.umlgraph.doclet.ClassGraph

classNumber - Static variable in class org.umlgraph.doclet.ClassInfo

classToUrl(ClassDoc, boolean) - Method in class org.umlgraph.doclet.ClassGraph

Convert the class name into a corresponding URL

classToUrl(String) - Method in class org.umlgraph.doclet.ClassGraph

Convert the class name into a corresponding URL

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

close() - Method in class org.umlgraph.doclet.ContextMatcher.DevNullWriter

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

collectionClassDoc - Variable in class org.umlgraph.doclet.ClassGraph

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

commentOptions - Static variable in class org.umlgraph.doclet.UmlGraph

Options used for commenting nodes

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

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

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

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

contextDoc - Variable in class org.umlgraph.doclet.ClassGraph

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

ContextMatcher.ClassGraphHack - Class in org.umlgraph.doclet

A quick hack to compute class dependencies reusing ClassGraph but without generating output.

ContextMatcher.DevNullWriter - Class in org.umlgraph.doclet

Simple dev/null imitation

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

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

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

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

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

DevNullWriter() - Constructor for class org.umlgraph.doclet.ContextMatcher.DevNullWriter

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

directions - Variable in class org.umlgraph.doclet.RelationPattern

A map from RelationType (indexes) to Direction objects

docletName - Static variable in class org.umlgraph.doclet.UmlGraph

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

E

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

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

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

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

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

epilogue() - Method in class org.umlgraph.doclet.ClassGraph

Dot epilogue

escape(String) - Method in class org.umlgraph.doclet.ClassGraph

Escape <, >, and & characters in the string with the corresponding HTML entity code.

EXPANDABLE_UML - Static variable in class org.umlgraph.doclet.UmlGraphDoc

EXPANDABLE_UML_STYLE - Static variable in class org.umlgraph.doclet.UmlGraphDoc

externalTableEnd() - Method in class org.umlgraph.doclet.ClassGraph

externalTableStart(Options, String, String) - Method in class org.umlgraph.doclet.ClassGraph

extraColumn(int) - Method in class org.umlgraph.doclet.Shape

Return the table border required for the shape

F

FieldRelationInfo(ClassDoc, boolean) - Constructor for class org.umlgraph.doclet.ClassGraph.FieldRelationInfo

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

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

FILE_SEPARATOR - Static variable in class org.umlgraph.doclet.ClassGraph

filterByVisibility(T[], Visibility) - Method in class org.umlgraph.doclet.ClassGraph

Returns all program element docs that have a visibility greater or equal than the specified level

findClass(RootDoc, String) - Static method in class org.umlgraph.doclet.UmlGraph

Return the ClassDoc for the specified class; null if not found.

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

findOutputPath(String[][]) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Returns the output path specified on the javadoc options

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

firstInnerTableEnd(Options, int) - Method in class org.umlgraph.doclet.ClassGraph

End the first inner table of a class.

firstInnerTableStart(Options, int) - Method in class org.umlgraph.doclet.ClassGraph

Start the first inner table of a class.

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

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

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

Trim and append a file separator to the string

flush() - Method in class org.umlgraph.doclet.ContextMatcher.DevNullWriter

Font() - Constructor for enum org.umlgraph.doclet.ClassGraph.Font

fontWrap(String, Options, ClassGraph.Font) - Method in class org.umlgraph.doclet.ClassGraph

Wraps the text with the appropriate font according to the specified font type

fontWrap(String, String, double) - Method in class org.umlgraph.doclet.ClassGraph

Wraps the text with the appropriate font tags when the font name and size are not void

G

generateContextDiagrams(RootDoc, Options, String) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Generates the context diagram for a single class

generatePackageDiagrams(RootDoc, Options, String) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Generates the package diagrams for all of the packages that contain classes among those returned by RootDoc.class()

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.

getClassInfo(String) - Method in class org.umlgraph.doclet.ClassGraph

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

getFieldRelationInfo(FieldDoc) - Method in class org.umlgraph.doclet.ClassGraph

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

getInterfaceTypeArguments(ClassDoc, Type) - Method in class org.umlgraph.doclet.ClassGraph

getNodeName(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

getNodeName(String) - Method in class org.umlgraph.doclet.ClassGraph

Return a class's internal name

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

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

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

Returns the options for the specified class.

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

Returns the options for the specified class.

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

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

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

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

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

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

getPackageName(String) - Method in class org.umlgraph.doclet.ClassGraph

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

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

getRelation(String) - Method in class org.umlgraph.doclet.ClassInfo

getUnqualifiedName(String) - Method in class org.umlgraph.doclet.ClassGraph

globalOptions - Variable in class org.umlgraph.doclet.ContextView

globalOptions - Variable in class org.umlgraph.doclet.View

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

Return the GraphViz shape name corresponding to the shape

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

Guillemot right (close)

guillemize(Options, String) - Method in class org.umlgraph.doclet.ClassGraph

Convert < and > characters in the string to the respective guillemot characters.

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

Guillemot left (open)

guilWrap(Options, String) - Method in class org.umlgraph.doclet.ClassGraph

Wraps a string in Guillemot (or an ASCII substitute) characters.

H

hidden(ProgramElementDoc) - Method in class org.umlgraph.doclet.ClassGraph

Return true if c has a @hidden tag associated with it

hidden(String) - Method in class org.umlgraph.doclet.ClassGraph

Return true if the class name is associated to an hidden class or matches a hide expression

hidden - Variable in class org.umlgraph.doclet.ClassInfo

True if the class class node is hidden

HIDE_OPTIONS - Static variable in class org.umlgraph.doclet.ContextView

hideOptions - Variable in class org.umlgraph.doclet.ContextView

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

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

htmlNewline(String) - Method in class org.umlgraph.doclet.ClassGraph

Convert embedded newlines into HTML line breaks

I

importedClasses(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Returns an array representing the imported classes of c.

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

Deprecated.

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

Deprecated.

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

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

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

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

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

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

innerTableEnd() - Method in class org.umlgraph.doclet.ClassGraph

innerTableStart() - Method in class org.umlgraph.doclet.ClassGraph

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

K

keepParentHide - Variable in class org.umlgraph.doclet.ContextMatcher

L

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

Return the shape's GraphViz landing port

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

linePostfix - Variable in class org.umlgraph.doclet.ClassGraph

linePrefix - Variable in class org.umlgraph.doclet.ClassGraph

M

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

mapApiDocRoot(String) - Method in class org.umlgraph.doclet.ClassGraph

Returns the appropriate URL "root" for a given class name.

mapClassDoc - Variable in class org.umlgraph.doclet.ClassGraph

matched - Variable in class org.umlgraph.doclet.ContextMatcher

matcher - Variable in class org.umlgraph.doclet.ContextView

matcher - Variable in class org.umlgraph.doclet.PackageView

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

Returns the options for the specified class.

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

Returns the options for the specified class.

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

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

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

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

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

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

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

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

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

matches(String) - 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

multiple - Variable in class org.umlgraph.doclet.ClassGraph.FieldRelationInfo

myGlobalOptions - Variable in class org.umlgraph.doclet.ContextView

N

name - Variable in class org.umlgraph.doclet.ClassInfo

Alias name for the class

name - Variable in class org.umlgraph.doclet.Shape

Shape's UMLGraph name

name - Variable in class org.umlgraph.doclet.WrappedClassDoc

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

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

newClassInfo(String, boolean, boolean) - Method in class org.umlgraph.doclet.ClassGraph

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

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

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

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

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

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

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

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

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

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

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

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

nodePrinted - Variable in class org.umlgraph.doclet.ClassInfo

True if the class class node has been printed

nodeProperties(Options) - Method in class org.umlgraph.doclet.ClassGraph

Print the common class node's properties

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

O

operations(Options, ConstructorDoc[]) - Method in class org.umlgraph.doclet.ClassGraph

Print the class's constructors m

operations(Options, MethodDoc[]) - Method in class org.umlgraph.doclet.ClassGraph

Print the class's operations m

opt - Variable in class org.umlgraph.doclet.ContextMatcher

The options will be used to decide on inference

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

optionOverrides - Variable in class org.umlgraph.doclet.View

optionProvider - Variable in class org.umlgraph.doclet.ClassGraph

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() - Constructor for class org.umlgraph.doclet.Options

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

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

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

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

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

outputPath - Variable in class org.umlgraph.doclet.PackageView

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

overrideForClass(Options, String) - 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, String) - 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, String) - Method in class org.umlgraph.doclet.Options

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

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

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

overrideForClass(Options, String) - 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

packageOptions - Variable in class org.umlgraph.doclet.ContextView

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

parameter(Options, Parameter[]) - Method in class org.umlgraph.doclet.ClassGraph

Print the method parameter p

parent - Variable in class org.umlgraph.doclet.PackageView

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

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

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

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

pd - Variable in class org.umlgraph.doclet.PackageView

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

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

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

printClass(ClassDoc, boolean) - Method in class org.umlgraph.doclet.ClassGraph

Prints the class if needed.

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

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

printExtraClasses(RootDoc) - Method in class org.umlgraph.doclet.ClassGraph

Print classes that were parts of relationships, but not parsed by javadoc

printInferredDependencies(ClassDoc[]) - Method in class org.umlgraph.doclet.ClassGraph

Prints dependencies recovered from the methods of a class.

printInferredDependencies(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Prints dependencies recovered from the methods of a class.

printInferredRelations(ClassDoc[]) - Method in class org.umlgraph.doclet.ClassGraph

Prints associations recovered from the fields of a class.

printInferredRelations(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Prints associations recovered from the fields of a class.

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

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

printRelations(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Print a class's relations

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

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

programName - Static variable in class org.umlgraph.doclet.UmlGraph

prologue() - Method in class org.umlgraph.doclet.ClassGraph

Dot prologue

prologue() - Method in class org.umlgraph.doclet.ContextMatcher.ClassGraphHack

provider - Variable in class org.umlgraph.doclet.View

Q

qualifiedName(Options, String) - Method in class org.umlgraph.doclet.ClassGraph

Return the class's name, possibly by stripping the leading path

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

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

R

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

relatedClasses - Variable in class org.umlgraph.doclet.ClassInfo

The list of classes that share a relation with this one.

relation(Options, RelationType, ClassDoc, String, ClassDoc, String, String, String, String) - Method in class org.umlgraph.doclet.ClassGraph

Print the specified relation

relation(Options, RelationType, ClassDoc, ClassDoc, String, String, String) - Method in class org.umlgraph.doclet.ClassGraph

Print the specified relation

RelationDirection - Enum in org.umlgraph.doclet

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

RelationDirection() - Constructor for enum org.umlgraph.doclet.RelationDirection

relationNode(ClassDoc) - Method in class org.umlgraph.doclet.ClassGraph

Return the full name of a relation's node.

relationNode(ClassDoc, String) - Method in class org.umlgraph.doclet.ClassGraph

Return the full name of a relation's node c.

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

RelationType() - Constructor for enum org.umlgraph.doclet.RelationType

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

removeTemplate(String) - Method in class org.umlgraph.doclet.ClassGraph

Removes the template specs from a class name.

reset() - Static method in class org.umlgraph.doclet.ClassInfo

Start numbering from zero.

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

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

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

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

rootClassdocs - Variable in class org.umlgraph.doclet.ClassGraph

rootClasses - Variable in class org.umlgraph.doclet.ClassGraph

runGraphviz(String, String, String, String, RootDoc) - Static method in class org.umlgraph.doclet.UmlGraphDoc

Runs Graphviz dot building both a diagram (in png format) and a client side map for it.

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

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

Loads the property file referred by apiDocMapFileName and fills the apiDocMap accordingly

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

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

Set the options based on a single option and its arguments

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 - Variable in class org.umlgraph.doclet.Options

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

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

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

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

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

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

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

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

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

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

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

stereotype(Options, Doc, ClassGraph.Align) - Method in class org.umlgraph.doclet.ClassGraph

Return as a string the stereotypes associated with c terminated by the escape character term

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

StringUtil - Class in org.umlgraph.doclet

String utility functions

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

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

tableLine(ClassGraph.Align, String) - Method in class org.umlgraph.doclet.ClassGraph

tableLine(ClassGraph.Align, String, Options, ClassGraph.Font) - Method in class org.umlgraph.doclet.ClassGraph

tags - Variable in class org.umlgraph.doclet.WrappedClassDoc

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

tagvalue(Options, Doc) - Method in class org.umlgraph.doclet.ClassGraph

Return as a string the tagged values associated with c

tokenize(String) - Static method in class org.umlgraph.doclet.StringUtil

Tokenize string s into an array

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

toString - Variable in class org.umlgraph.doclet.WrappedClassDoc

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

type(Options, Type) - Method in class org.umlgraph.doclet.ClassGraph

Print a a basic type t

typeAnnotation(Options, Type) - Method in class org.umlgraph.doclet.ClassGraph

Annotate an field/argument with its type t

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

typeParameters(Options, ParameterizedType) - Method in class org.umlgraph.doclet.ClassGraph

Print the parameters of the parameterized type t

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

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

U

UML_AUTO_SIZED_DIV_TAG - Static variable in class org.umlgraph.doclet.UmlGraphDoc

UML_DIV_TAG - Static variable in class org.umlgraph.doclet.UmlGraphDoc

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

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

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

V

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

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

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

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

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.ClassGraph.Align

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

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

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

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.

Version - Class in org.umlgraph.doclet

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

VERSION - Static variable in class org.umlgraph.doclet.Version

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

viewDoc - Variable in class org.umlgraph.doclet.View

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

visibility(Options, ProgramElementDoc) - Method in class org.umlgraph.doclet.ClassGraph

Print the visibility adornment of element e prefixed by any stereotypes

Visibility - Enum in org.umlgraph.doclet

Enumerates the possible visibilities in a Java program.

Visibility() - Constructor for enum org.umlgraph.doclet.Visibility

visited - Variable in class org.umlgraph.doclet.ContextMatcher

W

w - Variable in class org.umlgraph.doclet.ClassGraph

wrapped - Variable in class org.umlgraph.doclet.WrappedClassDoc

wrapped - Variable in class org.umlgraph.doclet.WrappedRootDoc

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

wrappedClassDocs - Variable in class org.umlgraph.doclet.WrappedRootDoc

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

write(char[], int, int) - Method in class org.umlgraph.doclet.ContextMatcher.DevNullWriter

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