Package nl.talsmasoftware.umldoclet.uml
Class Reference
java.lang.Object
nl.talsmasoftware.umldoclet.uml.UMLNode
nl.talsmasoftware.umldoclet.uml.Reference
Reference between two types.
The following reference types are currently supported:
- The 'extends' reference:
"--|>"
- The 'implements' reference:
"..|>"
- The 'inner class' reference:
"+--"
- Author:
- Sjoerd Talsma
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionfinal Reference.Side
final Collection<String>
final Reference.Side
final String
-
Constructor Summary
ConstructorDescriptionReference
(Reference.Side from, String type, Reference.Side to, String... notes) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether or not this reference contains the requested type.boolean
static Reference.Side
int
hashCode()
boolean
static Reference.Side
<IPW extends IndentingPrintWriter>
IPWwriteTo
(IPW output) Renders this object to the given indentingoutput
.Methods inherited from class nl.talsmasoftware.umldoclet.uml.UMLNode
addChild, findParent, getChildren, getChildren, getConfiguration, getParent, removeChildren, setParent, toString, writeChildrenTo
-
Field Details
-
from
-
to
-
type
-
notes
-
-
Constructor Details
-
Reference
-
-
Method Details
-
from
-
to
-
isSelfReference
public boolean isSelfReference() -
addNote
-
canonical
- Returns:
- The canonical type that can be used for equality matching.
-
writeTo
Description copied from class:UMLNode
Renders this object to the given indentingoutput
. -
contains
Returns whether or not this reference contains the requested type.- Parameters:
typeName
- The name of a type to check.- Returns:
- Whether either
from
orto
matchestypeName
.
-
hashCode
public int hashCode() -
equals
-