- U_END - Static variable in class org.tanjakostic.jcleancim.util.HTMLUtil
-
- U_START - Static variable in class org.tanjakostic.jcleancim.util.HTMLUtil
-
- UL_END - Static variable in class org.tanjakostic.jcleancim.util.HTMLUtil
-
- UL_START - Static variable in class org.tanjakostic.jcleancim.util.HTMLUtil
-
- uml - Static variable in class org.tanjakostic.jcleancim.experimental.builder.rdfs.XmlNamespace
-
- UML - Class in org.tanjakostic.jcleancim.model
-
All the names from UML models that we rely on for various processing.
- UML_CUSTOM_DOC_PROP - Static variable in interface org.tanjakostic.jcleancim.docgen.writer.Writer
-
Name for custom document property holding the UML model file name.
- UmlAssociation - Class in org.tanjakostic.jcleancim.model
-
UML association, with its two ends (UML classes).
- UmlAssociation.Data - Class in org.tanjakostic.jcleancim.model
-
- UmlAssociation.Direction - Enum in org.tanjakostic.jcleancim.model
-
Direction (navigability) of association.
- UmlAssociationEnd - Class in org.tanjakostic.jcleancim.model
-
UML association end.
- UmlAssociationEnd(UmlClass, UmlObjectData, UmlAssociationEnd.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlAssociationEnd
-
Constructor.
- UmlAssociationEnd.AssociationEndPair - Class in org.tanjakostic.jcleancim.model
-
Helper class, used to hold the two association ends of an association, from the perspective
of a UmlClass used as type for those ends.
- UmlAssociationEnd.Data - Class in org.tanjakostic.jcleancim.model
-
- UmlAssociationEnd.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of aggregation for association end.
- UmlAssociationEnd.Navigable - Enum in org.tanjakostic.jcleancim.model
-
Navigability of an association end.
- UmlAttribute - Class in org.tanjakostic.jcleancim.model
-
UML attribute or enumeration literal.
- UmlAttribute.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlAttribute
.
- UmlAttribute.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kinds of UML attributes - correspond mainly to the kind of the class used as the attribute's
type.
- UmlClass - Class in org.tanjakostic.jcleancim.model
-
UML class, interface or enumerated type.
- UmlClass(UmlPackage, UmlObjectData, UmlClass.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlClass
-
Creates a class without superclasses; convenient for stereotyped and root classes.
- UmlClass(UmlPackage, Collection<UmlClass>, UmlObjectData, UmlClass.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlClass
-
Creates the instance and adds itself to the containingPackage
, and as child to
every object from superclasses
.
- UmlClass.CimKind - Enum in org.tanjakostic.jcleancim.model
-
Kind of the UML class for CIM domain.
- UmlClass.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlClass
.
- UmlClass.Iec61850Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of the UML class for IEC 61850 domain.
- UmlClass.InheritedKind - Enum in org.tanjakostic.jcleancim.model
-
Used in queries for attributes, association ends and operations.
- UmlConstraint - Class in org.tanjakostic.jcleancim.model
-
UML constraint.
- UmlConstraint.Data - Class in org.tanjakostic.jcleancim.model
-
- UmlConstraint.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of constraint.
- UmlDependency - Class in org.tanjakostic.jcleancim.model
-
Explicit (hand-drawn) UML dependency between either two structures (packages or classes).
- UmlDependency.Data - Class in org.tanjakostic.jcleancim.model
-
- UmlDependency.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kinds of dependencies.
- UmlDiagram - Class in org.tanjakostic.jcleancim.model
-
Diagram from the UML model, assigned to either a class or a package.
- UmlDiagram.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlDiagram
.
- UmlDiagram.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of diagram, as given by EA.
- UmlKind - Interface in org.tanjakostic.jcleancim.model
-
Interface intended to be implemented by various *Kind enumerations, to allow for uniform
processing for any
UmlObject
.
- UmlModel - Class in org.tanjakostic.jcleancim.model
-
TODO: Add link to test model built with the API.
- UmlModel(Config) - Constructor for class org.tanjakostic.jcleancim.model.UmlModel
-
Constructor.
- UmlMultiplicity - Class in org.tanjakostic.jcleancim.model
-
We should use only 4 multiplicities in EA: [1], [1..*], [0..1] and [0..*].
- UmlMultiplicity.Kind - Enum in org.tanjakostic.jcleancim.model
-
Facilitates handling of IEC61850 class constraints (to ignore presence condition literals
which must be printed in the documentation, but are not actually used as constraints, rather
deduced from multiplicity of attribute).
- UmlObject - Interface in org.tanjakostic.jcleancim.model
-
Data common to all UML objects.
- UmlObjectBuilder<T extends UmlObject> - Interface in org.tanjakostic.jcleancim.builder
-
To avoid interface bloat, we follow the design pattern of Java collections API: to provide
"optional" methods and let implementations select which one they implement.
- UmlObjectData - Class in org.tanjakostic.jcleancim.model
-
Simple data structure that allows us to instantiate a subset of data of any
UmlObject
that can be initialised simply without any validation logic.
- UmlObjectData(String, String, TextDescription, TextDescription) - Constructor for class org.tanjakostic.jcleancim.model.UmlObjectData
-
Constructor useful when collecting model content for documentation.
- UmlObjectData(Integer, String, String, String, UmlStereotype, String, TextDescription, TextDescription) - Constructor for class org.tanjakostic.jcleancim.model.UmlObjectData
-
Constructor; accepts null arguments and initialises them with default values, so that all the
getters return non-null values.
- UmlObjectData(UmlObject) - Constructor for class org.tanjakostic.jcleancim.model.UmlObjectData
-
Copy constructor.
- UmlObjectsMissingDoc(Logger, String) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsMissingDoc
-
- UmlObjectsWithBadCharacterInName(Logger, String) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsWithBadCharacterInName
-
- UmlObjectsWithBadDocEnd(Logger, String) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsWithBadDocEnd
-
- UmlObjectsWithBadDocStart(Logger, String) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsWithBadDocStart
-
- UmlObjectsWithUnallowedStereotype(Logger, String, Set<String>) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsWithUnallowedStereotype
-
- UmlObjectsWithUnallowedTagNames(Logger, String) - Constructor for class org.tanjakostic.jcleancim.validation.AbstractRule.UmlObjectsWithUnallowedTagNames
-
- UmlOperation - Class in org.tanjakostic.jcleancim.model
-
UML operation.
- UmlOperation.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlOperation
.
- UmlOperation.ReturnKind - Enum in org.tanjakostic.jcleancim.model
-
- UmlPackage - Class in org.tanjakostic.jcleancim.model
-
UML package and its sub-packages hold the content of the model.
- UmlPackage(UmlModel, UmlObjectData, UmlPackage.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlPackage
-
Creates a model package (e.g.
- UmlPackage(UmlPackage, UmlObjectData, UmlPackage.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlPackage
-
Creates a top-level or a regular package, and adds itself to containingPackage
.
- UmlPackage.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlPackage
.
- UmlPackage.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of UML package, reflecting hierarchical package containment and common properties for
the model content below a given level.
- UmlParameter - Class in org.tanjakostic.jcleancim.model
-
Operation parameter.
- UmlParameter(UmlClass, UmlObjectData, UmlParameter.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlParameter
-
Constructor.
- UmlParameter.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlParameter
.
- UmlParameter.Kind - Enum in org.tanjakostic.jcleancim.model
-
- UmlSkipped - Class in org.tanjakostic.jcleancim.model
-
UML element or connector that we ignore, but track for validation purposes.
- UmlSkipped.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlSkipped
.
- UmlSkipped.Kind - Enum in org.tanjakostic.jcleancim.model
-
Kind of EA elements and connectors that may be found in the model, but are just skipped.
- UmlStereotype - Class in org.tanjakostic.jcleancim.model
-
UML stereotype.
- UmlStereotype(String...) - Constructor for class org.tanjakostic.jcleancim.model.UmlStereotype
-
Constructor.
- UmlStructure - Class in org.tanjakostic.jcleancim.model
-
Common implementation for collections contained by packages and classes.
- UmlStructure(UmlObjectData, UmlStructure.Data) - Constructor for class org.tanjakostic.jcleancim.model.UmlStructure
-
Creates common parts of structures.
- UmlStructure.Data - Class in org.tanjakostic.jcleancim.model
-
Data from the UML model repository specific to
UmlStructure
.
- UmlVisibility - Enum in org.tanjakostic.jcleancim.model
-
"Translates" EA visibility strings to lower case for classes, attributes, operations and
association ends.
- unsetDocgenOptimisationOptions() - Method in class org.tanjakostic.jcleancim.docgen.writer.word.AbstractWordWriter
-
- unsetDocgenOptimisationOptions() - Method in class org.tanjakostic.jcleancim.docgen.writer.word.doc.DocWordWriter
-
- unsetDocgenOptimisationOptions() - Method in interface org.tanjakostic.jcleancim.docgen.writer.word.WordHelper
-
- UnsupportedInputFormatException - Exception in org.tanjakostic.jcleancim.docgen
-
Used when the format for input document is a non-supported one.
- UnsupportedInputFormatException() - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedInputFormatException
-
- UnsupportedInputFormatException(String, Throwable) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedInputFormatException
-
- UnsupportedInputFormatException(String) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedInputFormatException
-
- UnsupportedInputFormatException(Throwable) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedInputFormatException
-
- UnsupportedOutputFormatException - Exception in org.tanjakostic.jcleancim.docgen
-
Used when the format for output document is a non-supported one.
- UnsupportedOutputFormatException() - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedOutputFormatException
-
- UnsupportedOutputFormatException(String, Throwable) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedOutputFormatException
-
- UnsupportedOutputFormatException(String) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedOutputFormatException
-
- UnsupportedOutputFormatException(Throwable) - Constructor for exception org.tanjakostic.jcleancim.docgen.UnsupportedOutputFormatException
-
- updateFields() - Method in class org.tanjakostic.jcleancim.docgen.writer.word.doc.DocWordWriter
-
- updateFields() - Method in class org.tanjakostic.jcleancim.docgen.writer.word.docx.DocxWordWriter
-
- updateFields() - Method in interface org.tanjakostic.jcleancim.docgen.writer.word.WordHelper
-
- updateModelErrorText() - Method in class org.tanjakostic.jcleancim.docgen.collector.PlaceholderSpec
-
Use this setter when finder could not find valid tokens in the model (e.g., format of the
placeholder is ok, but the names do not match elements in the model).
- updateRanges(CursorList<O>, Range<O>) - Method in class org.tanjakostic.jcleancim.docgen.writer.CursorList
-
- updateTablesOf(String) - Method in class org.tanjakostic.jcleancim.docgen.writer.word.doc.DocWordWriter
-
- updateTablesOf(String) - Method in class org.tanjakostic.jcleancim.docgen.writer.word.docx.DocxWordWriter
-
- updateTablesOf(String) - Method in interface org.tanjakostic.jcleancim.docgen.writer.word.WordHelper
-
- usableForFigureCaption(String) - Static method in enum org.tanjakostic.jcleancim.docgen.writer.Style
-
- usableForTableCaption(String) - Static method in enum org.tanjakostic.jcleancim.docgen.writer.Style
-
- useHtml(TextDescription) - Method in class org.tanjakostic.jcleancim.docgen.collector.impl.AbstractObjectDoc
-
Returns true if printing HTML is enabled and htmlDescription
is not empty.
- useHyperlinks - Variable in class org.tanjakostic.jcleancim.docgen.collector.DocgenConfig
-
- USER_DIR - Static variable in class org.tanjakostic.jcleancim.util.Util
-
- USER_DIR_KEY - Static variable in class org.tanjakostic.jcleancim.util.Util
-
- Util - Class in org.tanjakostic.jcleancim.util
-
Utility methods.
- Util.ImageFormat - Enum in org.tanjakostic.jcleancim.util
-
Image formats supported for UML diagrams.