Elements.Origin (Java SE 15 & JDK 15)
Description: declaration: module: java.compiler, package: javax.lang.model.util, interface: Elements, enum: Origin
Keywords: javax.lang.model.util.Elements.Origin class

Module java.compiler
Package javax.lang.model.util

# Enum Elements.Origin

java.lang.Object
java.lang.Enum<Elements.Origin>
javax.lang.model.util.Elements.Origin

All Implemented Interfaces:
  `Serializable`, `Comparable<Elements.Origin>`, `Constable`

Enclosing interface:
  Elements

    public static enum Elements.Origin
    extends Enum<Elements.Origin>

The origin of an element or other language model item. The origin of an element or item models how a construct in a program is declared in the source code, explicitly, implicitly, etc.

Note that it is possible additional kinds of origin values will be added in future versions of the platform.

See Java Language Specification:
  13.1 The Form of a Binary
Since:
  9

- ## Nested Class Summary

  ## Nested classes/interfaces declared in class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant | Description
  --- | ---
  `EXPLICIT` | Describes a construct explicitly declared in source code.
  `MANDATED` | A mandated construct is one that is not explicitly declared in the source code, but whose presence is mandated by the specification.
  `SYNTHETIC` | A synthetic construct is one that is neither implicitly nor explicitly declared in the source code.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `boolean` | `isDeclared()` | Returns `true` for values corresponding to constructs that are implicitly or explicitly declared, `false` otherwise.
  `static Elements.Origin` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
  `static Elements.Origin[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

  ### Methods declared in class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods declared in class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### EXPLICIT

    public static final Elements.Origin EXPLICIT
    Describes a construct explicitly declared in source code.

  - ### MANDATED

    public static final Elements.Origin MANDATED
    A mandated construct is one that is not explicitly declared in the source code, but whose presence is mandated by the specification. Such a construct is said to be implicitly declared. One example of a mandated element is a default constructor in a class that contains no explicit constructor declarations. Another example of a mandated construct is an implicitly declared container annotation used to hold multiple annotations of a repeatable annotation type.
    See Java Language Specification:
      8.8.9 Default Constructor
      8.9.3 Enum Members
      9.6.3 Repeatable Annotation Types
      9.7.5 Multiple Annotations of the Same Type

  - ### SYNTHETIC

    public static final Elements.Origin SYNTHETIC
    A synthetic construct is one that is neither implicitly nor explicitly declared in the source code. Such a construct is typically a translation artifact created by a compiler.

- ## Method Details

  - ### values

    public static Elements.Origin[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

    public static Elements.Origin valueOf​(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:
      `IllegalArgumentException` - if this enum type has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### isDeclared

    public boolean isDeclared()
    Returns `true` for values corresponding to constructs that are implicitly or explicitly declared, `false` otherwise.
    Returns:
      `true` for `EXPLICIT` and `MANDATED`, `false` otherwise.