java.lang.Object
- hydra.packaging.TermDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TermDefinition>
```
public class TermDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<TermDefinition>
```
A term-level definition, including a name, an optional signature, and a term

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`Term`	`body`	The term being defined
`static Name`	`BODY`	Name of the `hydra.packaging.TermDefinition.body` field.
`Optional<EntityMetadata>`	`metadata`	Optional documentation and lifecycle metadata for the term definition
`static Name`	`METADATA`	Name of the `hydra.packaging.TermDefinition.metadata` field.
`Name`	`name`	The name of the term
`static Name`	`NAME`	Name of the `hydra.packaging.TermDefinition.name` field.
`Optional<TermSignature>`	`signature`	The optional signature of the term.
`static Name`	`SIGNATURE`	Name of the `hydra.packaging.TermDefinition.signature` field.
`static Name`	`TYPE_`	Name of the `hydra.packaging.TermDefinition` type.

Constructor Summary

Constructors
Constructor	Description
`TermDefinition(Name name, Optional<EntityMetadata> metadata, Optional<TermSignature> signature, Term body)`	Constructs an immutable `TermDefinition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(TermDefinition other)`
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`TermDefinition`	`withBody(Term body)`	Returns a copy of this `TermDefinition` with `body` replaced.
`TermDefinition`	`withMetadata(Optional<EntityMetadata> metadata)`	Returns a copy of this `TermDefinition` with `metadata` replaced.
`TermDefinition`	`withName(Name name)`	Returns a copy of this `TermDefinition` with `name` replaced.
`TermDefinition`	`withSignature(Optional<TermSignature> signature)`	Returns a copy of this `TermDefinition` with `signature` replaced.

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

- Field Detail
  - TYPE_
```
public static final Name TYPE_
```
    Name of the hydra.packaging.TermDefinition type.
  - NAME
```
public static final Name NAME
```
    Name of the hydra.packaging.TermDefinition.name field.
  - METADATA
```
public static final Name METADATA
```
    Name of the hydra.packaging.TermDefinition.metadata field.
  - SIGNATURE
```
public static final Name SIGNATURE
```
    Name of the hydra.packaging.TermDefinition.signature field.
  - BODY
```
public static final Name BODY
```
    Name of the hydra.packaging.TermDefinition.body field.
  - name
```
public final Name name
```
    The name of the term
  - metadata
```
public final Optional<EntityMetadata> metadata
```
    Optional documentation and lifecycle metadata for the term definition
  - signature
```
public final Optional<TermSignature> signature
```
    The optional signature of the term. When absent, the signature has yet to be inferred.
  - body
```
public final Term body
```
    The term being defined
- Constructor Detail
  - TermDefinition
```
public TermDefinition(Name name,
                      Optional<EntityMetadata> metadata,
                      Optional<TermSignature> signature,
                      Term body)
```
    Constructs an immutable TermDefinition.
    
    Parameters:
    
    name - The name of the term
    
    metadata - Optional documentation and lifecycle metadata for the term definition
    
    signature - The optional signature of the term. When absent, the signature has yet to be inferred.
    
    body - The term being defined
- Method Detail
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(TermDefinition other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<TermDefinition>
  - withName
```
public TermDefinition withName(Name name)
```
    Returns a copy of this TermDefinition with name replaced.
  - withMetadata
```
public TermDefinition withMetadata(Optional<EntityMetadata> metadata)
```
    Returns a copy of this TermDefinition with metadata replaced.
  - withSignature
```
public TermDefinition withSignature(Optional<TermSignature> signature)
```
    Returns a copy of this TermDefinition with signature replaced.
  - withBody
```
public TermDefinition withBody(Term body)
```
    Returns a copy of this TermDefinition with body replaced.

Class TermDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_

NAME

METADATA

SIGNATURE

BODY

name

metadata

signature

body

Constructor Detail

TermDefinition

Method Detail

equals

hashCode

compareTo

withName

withMetadata

withSignature

withBody