Package hydra.typeScript.syntax

Class ModuleItemWithComments

java.lang.Object

hydra.typeScript.syntax.ModuleItemWithComments

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModuleItemWithComments>

public class ModuleItemWithComments
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ModuleItemWithComments>

A module item with optional documentation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleItemWithComments.Builder	A fluent builder for ModuleItemWithComments.

Field Summary

Fields

Modifier and Type	Field	Description
ModuleItem	body	The module item
static Name	BODY	Name of the hydra.typeScript.syntax.ModuleItemWithComments.body field.
Optional<DocumentationComment>	comments	Optional documentation comment
static Name	COMMENTS	Name of the hydra.typeScript.syntax.ModuleItemWithComments.comments field.
static Name	TYPE_	Name of the hydra.typeScript.syntax.ModuleItemWithComments type.

Constructor Summary

Constructors

Constructor	Description
ModuleItemWithComments(ModuleItem body, Optional<DocumentationComment> comments)	Constructs an immutable ModuleItemWithComments.

Method Summary

Modifier and Type	Method	Description
static ModuleItemWithComments.Builder	builder()	Creates a new fluent builder for ModuleItemWithComments.
int	compareTo(ModuleItemWithComments other)
boolean	equals(java.lang.Object other)
int	hashCode()
java.lang.String	toString()
ModuleItemWithComments	withBody(ModuleItem body)	Returns a copy of this ModuleItemWithComments with body replaced.
ModuleItemWithComments	withComments(Optional<DocumentationComment> comments)	Returns a copy of this ModuleItemWithComments with comments replaced.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_

public static final Name TYPE_

Name of the hydra.typeScript.syntax.ModuleItemWithComments type.

BODY

public static final Name BODY

Name of the hydra.typeScript.syntax.ModuleItemWithComments.body field.

COMMENTS

public static final Name COMMENTS

Name of the hydra.typeScript.syntax.ModuleItemWithComments.comments field.

body

public final ModuleItem body

The module item

comments

public final Optional<DocumentationComment> comments

Optional documentation comment

Constructor Detail

ModuleItemWithComments

public ModuleItemWithComments(ModuleItem body,
                              Optional<DocumentationComment> comments)

Constructs an immutable ModuleItemWithComments.

Parameters:

body - The module item

comments - Optional documentation comment

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ModuleItemWithComments other)

Specified by:

compareTo in interface java.lang.Comparable<ModuleItemWithComments>

withBody

public ModuleItemWithComments withBody(ModuleItem body)

Returns a copy of this ModuleItemWithComments with body replaced.

withComments

public ModuleItemWithComments withComments(Optional<DocumentationComment> comments)

Returns a copy of this ModuleItemWithComments with comments replaced.

builder

public static ModuleItemWithComments.Builder builder()

Creates a new fluent builder for ModuleItemWithComments.