org.forgerock.openam.docs.ssoadm

Class SsoadmAP

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.forgerock.openam.docs.ssoadm.SsoadmAP

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes(value="*")
public class SsoadmAP
extends AbstractProcessor

Annotation processor to generate DocBook 5 XML-based reference content for the ssoadm command. Annotations specifying ssoadm subcommand info are provided by two files: openam/openam-cli/openam-cli-definitions/src/main/java/com/sun/identity/cli/definition/AccessManager.java openam/openam-cli/openam-cli-definitions/src/main/java/com/sun/identity/federation/cli/definition/FederationManager.java The ssoadm <refentry> incorporates a sorted list of subcommands and their options.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
SsoadmAP()

Method Summary

Modifier and Type	Method and Description
Set<String>	getSubcommands() After processing is complete, the set of subcommands contains the documentation for the ssoadm <referentry>.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Two field annotations hold documentation content: @Macro and

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SsoadmAP

public SsoadmAP()

Method Detail

getSubcommands

public Set<String> getSubcommands()

After processing is complete, the set of subcommands contains the documentation for the ssoadm <referentry>.

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnv)

Two field annotations hold documentation content: @Macro and

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor