SymbolReference.ContextOption (smithy-codegen-core 1.0.5 API)

java.lang.Object
- java.lang.Enum<SymbolReference.ContextOption>
- - software.amazon.smithy.codegen.core.SymbolReference.ContextOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SymbolReference.ContextOption>, SymbolReference.Option

Enclosing class:

SymbolReference
```
public static enum SymbolReference.ContextOption
extends java.lang.Enum<SymbolReference.ContextOption>
implements SymbolReference.Option
```
Options used to control the context of when the symbol reference is needed.
These context options are used to define the context in which one symbol refers to another. For example, if a reference is only needed when the symbol is defined and not needed when the symbol is used, then code generators can automatically add the necessary imports for each circumstance.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DECLARE`	Indicates that the referenced symbol is needed when declaring the symbol.
`USE`	Indicates that the referenced symbol is needed when importing/using the symbol.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static SymbolReference.ContextOption`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static SymbolReference.ContextOption[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DECLARE
```
public static final SymbolReference.ContextOption DECLARE
```
    Indicates that the referenced symbol is needed when declaring the symbol.
  - USE
```
public static final SymbolReference.ContextOption USE
```
    Indicates that the referenced symbol is needed when importing/using the symbol.
- Method Detail
  - values
```
public static SymbolReference.ContextOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (SymbolReference.ContextOption c : SymbolReference.ContextOption.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SymbolReference.ContextOption valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null