Package hydra.go.syntax

Class AnnotatedDeclaration

java.lang.Object

hydra.go.syntax.AnnotatedDeclaration

All Implemented Interfaces:

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

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

A top-level Go declaration together with its preceding comment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	comment
static Name	COMMENT	Name of the hydra.go.syntax.AnnotatedDeclaration.comment field.
TopLevelDecl	declaration
static Name	DECLARATION	Name of the hydra.go.syntax.AnnotatedDeclaration.declaration field.
static Name	TYPE_	Name of the hydra.go.syntax.AnnotatedDeclaration type.

Constructor Summary

Constructors

Constructor	Description
AnnotatedDeclaration(java.lang.String comment, TopLevelDecl declaration)	Constructs an immutable AnnotatedDeclaration.

Method Summary

Modifier and Type	Method	Description
static AnnotatedDeclaration.Builder	builder()	Creates a new fluent builder for AnnotatedDeclaration.
int	compareTo(AnnotatedDeclaration other)
boolean	equals(java.lang.Object other)
int	hashCode()
java.lang.String	toString()
AnnotatedDeclaration	withComment(java.lang.String comment)	Returns a copy of this AnnotatedDeclaration with comment replaced.
AnnotatedDeclaration	withDeclaration(TopLevelDecl declaration)	Returns a copy of this AnnotatedDeclaration with declaration 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.go.syntax.AnnotatedDeclaration type.

COMMENT

public static final Name COMMENT

Name of the hydra.go.syntax.AnnotatedDeclaration.comment field.

DECLARATION

public static final Name DECLARATION

Name of the hydra.go.syntax.AnnotatedDeclaration.declaration field.

comment

public final java.lang.String comment

declaration

public final TopLevelDecl declaration

Constructor Detail

AnnotatedDeclaration

public AnnotatedDeclaration(java.lang.String comment,
                            TopLevelDecl declaration)

Constructs an immutable AnnotatedDeclaration.

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(AnnotatedDeclaration other)

Specified by:

compareTo in interface java.lang.Comparable<AnnotatedDeclaration>

withComment

public AnnotatedDeclaration withComment(java.lang.String comment)

Returns a copy of this AnnotatedDeclaration with comment replaced.

withDeclaration

public AnnotatedDeclaration withDeclaration(TopLevelDecl declaration)

Returns a copy of this AnnotatedDeclaration with declaration replaced.

builder

public static AnnotatedDeclaration.Builder builder()

Creates a new fluent builder for AnnotatedDeclaration.