Index (Feature Pack Documentation Generator 8.0.0.Final API)

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

address() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns the value of the address record component.
append(String) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
append(String, String) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
append(Path, Path) - Static method in class org.wildfly.galleon.plugin.doc.generator.LogMessageGenerator: Appends a path to a base path, converting absolute paths to relative.
append(List<PathElement>) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Create a new path address by appending more elements to the end of this address.
append(PathAddress) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Create a new path address by appending more elements to the end of this address.
append(PathElement...) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Create a new path address by appending more elements to the end of this address.
artifactId() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the artifactId record component.
attribute() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns the value of the attribute record component.
AttributeConfiguration(String, String, Set<String>, Set<String>) - Constructor for record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Creates an instance of a AttributeConfiguration record class.

C

configurations() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the configurations record component.
containsLayer(String) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata

D

debug(String) - Method in interface org.wildfly.galleon.plugin.doc.generator.SimpleLog
dependencies() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the dependencies record component.
description() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the description record component.
description() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer
DocGenerator - Class in org.wildfly.galleon.plugin.doc.generator
DocGenerator() - Constructor for class org.wildfly.galleon.plugin.doc.generator.DocGenerator

E

EMPTY_ADDRESS - Static variable in class org.wildfly.galleon.plugin.doc.generator.PathAddress: An empty address.
envVars() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns the value of the envVars record component.
equals(Object) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Determine whether this object is equal to another.
equals(Object) - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Determine whether this object is equal to another.
equals(PathAddress) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Determine whether this object is equal to another.
equals(PathElement) - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Determine whether this object is equal to another.

F

FileUtils - Class in org.wildfly.galleon.plugin.doc.generator
FileUtils() - Constructor for class org.wildfly.galleon.plugin.doc.generator.FileUtils

G

generate(SimpleLog, Path, Path, Path, Path, Path, Path) - Static method in class org.wildfly.galleon.plugin.doc.generator.DocGenerator: Generate documentation from the feature pack's metadata and model.
generateModel(Path, Path, Path) - Static method in class org.wildfly.galleon.plugin.doc.generator.DocGenerator: Generate the model reference in the outputDirectory
getElement(int) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Gets the element at the given index.
getKey() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Get the path key.
getKeyValuePair() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement
getLastElement() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Gets the last element in the address.
getParent() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
getSegments() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement
getValue() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Get the path value.
groupId() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the groupId record component.

H

hashCode() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns a hash code value for this object.
hashCode() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns a hash code value for this object.
hashCode() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns a hash code value for this object.
hashCode() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Returns a hash code value for this object.
hashCode() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Returns a hash code value for this object.
hashCode() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
hashCode() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement

I

info(String) - Method in interface org.wildfly.galleon.plugin.doc.generator.SimpleLog
isDebugEnabled() - Method in interface org.wildfly.galleon.plugin.doc.generator.SimpleLog
isMultiTarget() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Check whether this address applies to multiple targets.
isMultiTarget() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement
isWildcard() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Determine whether the value is the wildcard value.
iterator() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Iterate over the elements of this path address.

L

Layer(String, String, List<Metadata.LayerDependency>, ObjectNode, List<Metadata.Property>, List<Metadata.AttributeConfiguration>, Set<String>) - Constructor for record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Creates an instance of a Layer record class.
LayerDependency(String, boolean) - Constructor for record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Creates an instance of a LayerDependency record class.
layers() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the layers record component.
licenses() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the licenses record component.
LogMessageGenerator - Class in org.wildfly.galleon.plugin.doc.generator: A utility to export message id's and messages from Jar files.
LogMessageGenerator() - Constructor for class org.wildfly.galleon.plugin.doc.generator.LogMessageGenerator

M

managementModel() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the managementModel record component.
matches(Property) - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Determine whether the given property matches this element.
Metadata - Record Class in org.wildfly.galleon.plugin.doc.generator
Metadata(String, String, String, String, String, List<String>, String, String, List<Metadata.Layer>) - Constructor for record class org.wildfly.galleon.plugin.doc.generator.Metadata: Creates an instance of a Metadata record class.
Metadata.AttributeConfiguration - Record Class in org.wildfly.galleon.plugin.doc.generator
Metadata.Layer - Record Class in org.wildfly.galleon.plugin.doc.generator
Metadata.LayerDependency - Record Class in org.wildfly.galleon.plugin.doc.generator
Metadata.Property - Record Class in org.wildfly.galleon.plugin.doc.generator

N

name() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the name record component.
name() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Returns the value of the name record component.
name() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the name record component.
name() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Returns the value of the name record component.
navigate(ModelNode, boolean) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Navigate to this address in the given model node.
note() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer

O

optional() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Returns the value of the optional record component.
org.wildfly.galleon.plugin.doc.generator - package org.wildfly.galleon.plugin.doc.generator

P

packages() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the packages record component.
parseCLIStyleAddress(String) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
pathAddress(String, String) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
pathAddress(List<PathElement>) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
pathAddress(ModelNode) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Creates a PathAddress from the given ModelNode address.
pathAddress(PathAddress, PathElement...) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
pathAddress(PathElement...) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
PathAddress - Class in org.wildfly.galleon.plugin.doc.generator: A path address for an operation.
pathElement(String) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Construct a new instance with a wildcard value.
pathElement(String, String) - Static method in class org.wildfly.galleon.plugin.doc.generator.PathElement: Construct a new instance.
PathElement - Class in org.wildfly.galleon.plugin.doc.generator: An element of a path specification for matching operations with addresses.
prettyManagementModel() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer
properties() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the properties record component.
Property(String, String) - Constructor for record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Creates an instance of a Property record class.

R

remove(ModelNode) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Navigate to, and remove, this address in the given model node.

S

scmUrl() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the scmUrl record component.
SimpleLog - Interface in org.wildfly.galleon.plugin.doc.generator
size() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Get the size of this path, in elements.
stability() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns the value of the stability record component.
subAddress(int) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Get a portion of this address using segments starting at start (inclusive).
subAddress(int, int) - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Get a portion of this address using segments between start (inclusive) and end (exclusive).
SYSTEM_LOG - Static variable in interface org.wildfly.galleon.plugin.doc.generator.SimpleLog
systemProperties() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns the value of the systemProperties record component.

T

TemplateUtils - Class in org.wildfly.galleon.plugin.doc.generator
TemplateUtils() - Constructor for class org.wildfly.galleon.plugin.doc.generator.TemplateUtils
toCLIStyleString() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
toHttpStyleString() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
toModelNode() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress: Convert this path address to its model node representation.
toPathStyleString() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
toString() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.AttributeConfiguration: Returns a string representation of this record class.
toString() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Layer: Returns a string representation of this record class.
toString() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.LayerDependency: Returns a string representation of this record class.
toString() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Returns a string representation of this record class.
toString() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns a string representation of this record class.
toString() - Method in class org.wildfly.galleon.plugin.doc.generator.PathAddress
toString() - Method in class org.wildfly.galleon.plugin.doc.generator.PathElement

U

url() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the url record component.

V

value() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata.Property: Returns the value of the value record component.
version() - Method in record class org.wildfly.galleon.plugin.doc.generator.Metadata: Returns the value of the version record component.

W

WILDCARD_VALUE - Static variable in class org.wildfly.galleon.plugin.doc.generator.PathElement

A C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values