R-Index (org.tquadrat.foundation.javadoc 0.2.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

R

registerAttributes(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.AttributeSupport: Registers the valid attributes for the owning element.
registerAttributeSequence(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLDocumentImpl: Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.

The names for the attributes are not validated; in particular, it is not checked whether an attribute is listed as valid.
registerAttributeSequence(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Registers an attribute sequence for this element; this modifies any sort order that was previously set.

The names for the attributes are not validated; in particular, it is not checked whether an attribute is listed as valid.
registerAttributeSequence(Comparator<String>) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLDocumentImpl: Registers an attribute sequence for the root element of this document; this modifies any sort order that was previously set.
registerAttributeSequence(Comparator<String>) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Registers an attribute sequence for this element; this modifies any sort order that was previously set.
registerChildren(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.ChildSupport: Registers the element names of valid child elements for the owning element.
registerSequence(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.AttributeSupport: Registers an attribute sequence for the owning element; this modifies any sort order that was previously set.
registerValidAttributes(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLDocumentImpl: Registers the valid attributes for the root element of this document.
registerValidAttributes(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Registers the valid attributes for this element.

Nothing happens if AttributeSupport.checksIfValid() returns false, although a call to this method is obsolete then.
registerValidChildren(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLDocumentImpl: Registers the element names of valid child elements for this document.
registerValidChildren(String...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Registers the element names of valid child elements for this element.
registerWithParent(SVGElement) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGGenericElement: Registers this element as a valid child with the given parent.
removeSymbol(TypeSymbol) - Method in class org.tquadrat.foundation.javadoc.umlgraph.UMLGraphLayout.UMLGraphLayoutRow: Removes the given type symbol from the contents of this row.
removeValidatorChangeListener(XMLBuilderUtils.ValidatorChangeListener) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.XMLBuilderUtils: Removes the given validator change listener.
RENDERABLE - Enum constant in enum class org.tquadrat.foundation.javadoc.internal.foundation.svg.type.SVGElementCategory: Renderable element.
renderSVGText() - Method in class org.tquadrat.foundation.javadoc.umlgraph.UMLMemberElement: Renders SVGText element that will display this member.
renderSVGText() - Method in class org.tquadrat.foundation.javadoc.umlgraph.UMLMethodElement: Renders SVGText element that will display this member.
renderSVGText() - Method in class org.tquadrat.foundation.javadoc.umlgraph.UMLVariableElement: Renders SVGText element that will display this member.
repeat(int) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.SGMLPrinter: Returns a String, consisting only of blanks, with the length that is determined by the given indentation level, multiplied by the SGMLPrinter.TAB_SIZE (= 4).
repeat(int, int) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.SGMLPrinter: Returns a String, consisting only of blanks, with the length that is determined by the given indentation level, multiplied by the SGMLPrinter.TAB_SIZE (= 4), plus the given number of additional blanks.
replaceVariable(CharSequence, Function<? super String, Optional<String>>) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.util.Template: Replaces the variables of the form ${<name>} in the given String with values returned by the given retriever function for the variable name.

If no replacement value could be found, the variable will not be replaced at all.

If the retriever function returns a value that contains a variable itself, this will not be replaced.

The retriever function will be called only once for each variable name; if the text contains the same variable multiple times, it will always be replaced with the same value.

The variables names are case-sensitive.

Valid variable name may not contain other characters than the letters from 'a' to 'z' (upper case and lower case), the digits from '0' to '9' and the special characters underscore ('_') and dot ('.'), after an optional prefix character.

Allowed prefixes are the tilde ('~'), the slash ('/'), the equal sign ('='), the colon (':'), the percent sign ('%'), and the ampersand ('&').

The prefix character is part of the name.

Finally, there is the single underscore that is allowed as a special variable.
replaceVariable(CharSequence, Map<String, ?>...) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.util.Template: Replaces the variables of the form ${<name>} in the given String with values from the given maps.
replaceVariable(Function<? super String, Optional<String>>) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.util.Template: Replaces the variables of the form ${<name>} in the adjusted template with values returned by the given retriever function for the variable name, and returns it after formatting the result.

If no replacement value could be found, the variable will not be replaced at all.

If the retriever function returns a value that contains a variable itself, this will not be replaced.

The retriever function will be called only once for each variable name; if the text contains the same variable multiple times, it will always be replaced with the same value.

The variables names are case-sensitive.

Valid variable name may not contain other characters than the letters from 'a' to 'z' (upper case and lower case), the digits from '0' to '9' and the special characters underscore ('_') and dot ('.'), after an optional prefix character.

Allowed prefixes are the tilde ('~'), the slash ('/'), the equal sign ('='), the colon (':'), the percent sign ('%'), and the ampersand ('&').

The prefix character is part of the name.

Finally, there is the single underscore that is allowed as a special variable.
replaceVariable(Map<String, ?>...) - Method in class org.tquadrat.foundation.javadoc.internal.foundation.util.Template: Replaces the variables of the form ${<name>} in the adjusted template with values from the given maps and returns it after formatting the result.
requireNonNullArgument(T, String) - Static method in class org.tquadrat.foundation.javadoc.internal.ToolKit: Checks if the given argument a is null and throws a NullArgumentException if it is null.
requireNotEmptyArgument(Optional<T>, String) - Static method in class org.tquadrat.foundation.javadoc.internal.ToolKit: Checks if the given argument a of type Optional is null or empty and throws a NullArgumentException if it is null, or a EmptyArgumentException if it is empty.

Otherwise it returns the value of the Optional.

This is different from the behaviour of ToolKit.requireNotEmptyArgument(Object,String) with an instance of Optional as the argument to test.
requireNotEmptyArgument(T, String) - Static method in class org.tquadrat.foundation.javadoc.internal.ToolKit: Checks if the given argument a is null or empty and throws a NullArgumentException if it is null, or a EmptyArgumentException if it is empty.

Strings, arrays, Collections, and Maps will be checked on being empty; this includes instances of StringBuilder, StringBuffer, and CharSequence.

For an instance of Optional, the presence of a value is checked in order to determine whether it is empty or not.

Because the interface Enumeration does not provide an API for the check on emptiness (hasMoreElements() will return false after all elements have been taken from the Enumeration instance), the result for arguments of this type has to be taken with caution.

For instances of Stream, this method will only check for null (like ToolKit.requireNonNullArgument(Object,String).
restoreDefaultValidators() - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.XMLBuilderUtils: Sets the validators back to the default configuration.
retrieveElementCategory(String) - Static method in enum class org.tquadrat.foundation.javadoc.internal.foundation.svg.type.SVGElementCategory: Retrieves the element category for the given element name.
retrieveParameters() - Method in class org.tquadrat.foundation.javadoc.umlgraph.UMLExecutableElement: Composes the parameters list for this executable element to a String.
retrieveParents(UMLTypeElement) - Method in class org.tquadrat.foundation.javadoc.UmlGraphLinkTaglet: Retrieves the direct parents for the given type.

As this method potentially modifies the cache, it requires the lock.
retrieveValidAttributes() - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Returns the list of the registered attributes.
retrieveValidAttributes() - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.AttributeSupport: Returns the list of the registered attributes.
retrieveValidChildren() - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl: Returns the list of the registered children.
retrieveValidChildren() - Method in class org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.ChildSupport: Returns the list of the registered children.
retrieveVariableValue(String, Map<String, ?>...) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.util.Template: Tries to obtain a value for the given key from one of the given sources that will be searched in the given sequence order.
rootPathRetriever(String) - Static method in class org.tquadrat.foundation.javadoc.internal.OtherFileTagletBase: Looks up the system properties for a root path for include files with the given name (the full name would be the prefix "org.tquadrat.foundation.include.root" appended by the argument, separated by a '.'.
rotate(double) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGUtils: Creates an instance of SVGTransform.SVGRotate.
rotate(double, double, double) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGUtils: Creates an instance of SVGTransform.SVGRotate.
rotate(long) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGUtils: Creates an instance of SVGTransform.SVGRotate.
rotate(long, long, long) - Static method in class org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGUtils: Creates an instance of SVGTransform.SVGRotate.

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form