Top Description Fields Constructors Methods
com.github.javaparser.ast.modules

public Class ModuleDeclaration

extends Node
implements NodeWithName<ModuleDeclaration>, NodeWithAnnotations<ModuleDeclaration>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, com.github.javaparser.ast.nodeTypes.NodeWithName
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .NodeList, .Generated, com.github.javaparser.ast.expr.AnnotationExpr, .Name, com.github.javaparser.ast.nodeTypes.NodeWithAnnotations, .NodeWithName, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.JavaParserMetaModel, .ModuleDeclarationMetaModel, com.github.javaparser.TokenRange
A Java 9 Jigsaw module declaration. @Foo module com.github.abc { requires a.B; }

Field Summary

Modifier and TypeField and Description
private NodeList<AnnotationExpr>
annotations

private NodeList<ModuleDirective>
directives

private boolean
isOpen

private Name
name

Inherited from com.github.javaparser.ast.Node:
ABSOLUTE_BEGIN_LINEABSOLUTE_END_LINENODE_BY_BEGIN_POSITIONprettyPrinterNoCommentsConfigurationSYMBOL_RESOLVER_KEY

Constructor Summary

AccessConstructor and Description
public
ModuleDeclaration()

public
ModuleDeclaration(Name name, boolean isOpen)

public
ModuleDeclaration(NodeList<AnnotationExpr> annotations, Name name, boolean isOpen, NodeList<ModuleDirective> directives)

public
ModuleDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, Name name, boolean isOpen, NodeList<ModuleDirective> directives)

This constructor is used by the parser and is considered private.

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public ModuleDeclaration
addDirective(String directive)

Add a directive to the module, like "exports R.S to T1.U1, T2.U2;"

public ModuleDeclaration
addDirective(ModuleDirective directive)

public ModuleDeclaration
clone()

Overrides com.github.javaparser.ast.Node.clone.

Creates and returns a copy of this object.
public NodeList<AnnotationExpr>
getAnnotations()

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

public NodeList<ModuleDirective>
getDirectives()

public ModuleDeclarationMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

public Name
getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

public boolean
isOpen()

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

public ModuleDeclaration
setAnnotations(final NodeList<AnnotationExpr> annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

public ModuleDeclaration
setDirectives(final NodeList<ModuleDirective> directives)

public ModuleDeclaration
setName(final Name name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

public ModuleDeclaration
setOpen(final boolean isOpen)

Inherited from com.github.javaparser.ast.Node:
addOrphanCommentcontainsDatacustomInitializationequalsfindAllfindAllfindCompilationUnitfindFirstfindFirstfindFirstfindRootNodegetAllContainedCommentsgetChildNodesgetChildNodesByTypegetCommentgetDatagetDataKeysgetNodesByTypegetOrphanCommentsgetParentNodegetParentNodeForChildrengetParsedgetRangegetSymbolResolvergetTokenRangegetToStringPrettyPrinterConfigurationhashCodeisAncestorOfisRegisterednotifyPropertyChangeregisterregisterregisterForSubtreeremoveremoveCommentremoveDataremoveForcedremoveOrphanCommentreplacesetAsParentNodeOfsetAsParentNodeOfsetBlockCommentsetCommentsetDatasetLineCommentsetParentNodesetParsedsetRangesetTokenRangesetToStringPrettyPrinterConfigurationstreamstreamtoStringtoStringtryAddImportToParentCompilationUnitunregisterwalkwalkwalk

Field Detail

annotationsback to summary
private NodeList<AnnotationExpr> annotations
directivesback to summary
private NodeList<ModuleDirective> directives
isOpenback to summary
private boolean isOpen
nameback to summary
private Name name

Constructor Detail

ModuleDeclarationback to summary
public ModuleDeclaration()
ModuleDeclarationback to summary
public ModuleDeclaration(Name name, boolean isOpen)
ModuleDeclarationback to summary
public ModuleDeclaration(NodeList<AnnotationExpr> annotations, Name name, boolean isOpen, NodeList<ModuleDirective> directives)
Annotations
@AllFieldsConstructor
ModuleDeclarationback to summary
public ModuleDeclaration(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, Name name, boolean isOpen, NodeList<ModuleDirective> directives)

This constructor is used by the parser and is considered private.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
addDirectiveback to summary
public ModuleDeclaration addDirective(String directive)

Add a directive to the module, like "exports R.S to T1.U1, T2.U2;"

addDirectiveback to summary
public ModuleDeclaration addDirective(ModuleDirective directive)
cloneback to summary
public ModuleDeclaration clone()

Overrides com.github.javaparser.ast.Node.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ModuleDeclaration

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getAnnotationsback to summary
public NodeList<AnnotationExpr> getAnnotations()

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.getAnnotations.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getDirectivesback to summary
public NodeList<ModuleDirective> getDirectives()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public ModuleDeclarationMetaModel getMetaModel()

Overrides com.github.javaparser.ast.Node.getMetaModel.

Returns:ModuleDeclarationMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getNameback to summary
public Name getName()

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.getName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
isOpenback to summary
public boolean isOpen()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.Node.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.Node.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
setAnnotationsback to summary
public ModuleDeclaration setAnnotations(final NodeList<AnnotationExpr> annotations)

Implements com.github.javaparser.ast.nodeTypes.NodeWithAnnotations.setAnnotations.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setDirectivesback to summary
public ModuleDeclaration setDirectives(final NodeList<ModuleDirective> directives)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setNameback to summary
public ModuleDeclaration setName(final Name name)

Implements com.github.javaparser.ast.nodeTypes.NodeWithName.setName.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setOpenback to summary
public ModuleDeclaration setOpen(final boolean isOpen)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator