Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.api.plugins.antlr.metadata
[Java] Class XRef

    java.lang.Object
      org.gradle.api.plugins.antlr.metadata.XRef

    public class XRef

Models cross-reference (x-ref) info about GrammarFileMetadata such as filesByPath, filesByExportVocab and filesByClassName.

Authors:
  Steve Ebersole

Constructor Summary
`XRef(Hierarchy antlrHierarchy)`

Method Summary
`java.lang.Object` | `getAntlrHierarchy()`
`GrammarFileMetadata` | `getGrammarFileByClassName(java.lang.String className)` Locate the grammar file metadata by the name of a class generated from one of its included grammars.
`GrammarFileMetadata` | `getGrammarFileByExportVocab(java.lang.String vocabName)` Locate the grammar file metadata by the name of a vocabulary exported from one of its included grammars.
`GrammarFileMetadata` | `getGrammarFileByPath(java.lang.String path)` Locate the grammar file metadata by grammar file path.
`java.util.Iterator` | `iterateGrammarFiles()`

Methods inherited from class java.lang.Object
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Constructor Detail

### XRef

    public XRef(Hierarchy antlrHierarchy)

Method Detail

### getAntlrHierarchy

    public java.lang.Object getAntlrHierarchy()

### getGrammarFileByClassName

    public GrammarFileMetadata getGrammarFileByClassName(java.lang.String className)

  Locate the grammar file metadata by the name of a class generated from one of its included grammars.
  Parameters:
    `className` - The generated class name.
  Returns:
    The grammar file metadata. May be null if none found.

### getGrammarFileByExportVocab

    public GrammarFileMetadata getGrammarFileByExportVocab(java.lang.String vocabName)

  Locate the grammar file metadata by the name of a vocabulary exported from one of its included grammars.
  Parameters:
    `vocabName` - The vocabulary name
  Returns:
    The grammar file metadata. May be null if none found.

### getGrammarFileByPath

    public GrammarFileMetadata getGrammarFileByPath(java.lang.String path)

  Locate the grammar file metadata by grammar file path.
  Parameters:
    `path` - The grammar file path.
  Returns:
    The grammar file metadata. May be null if none found.

### iterateGrammarFiles

    public java.util.Iterator iterateGrammarFiles()

Groovy Documentation