Package hydra.lisp.syntax

Class FunctionDefinition

java.lang.Object

hydra.lisp.syntax.FunctionDefinition

All Implemented Interfaces:

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

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

A named function definition. Serializes as (defn name [params] body) in Clojure, (defun name (params) body) in Emacs Lisp and Common Lisp, (define (name params) body) in Scheme

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
java.util.List<Expression>	body	The function body (one or more expressions)
static Name	BODY	Name of the hydra.lisp.syntax.FunctionDefinition.body field.
Optional<Docstring>	doc	Optional docstring
static Name	DOC	Name of the hydra.lisp.syntax.FunctionDefinition.doc field.
Symbol	name	The function name
static Name	NAME	Name of the hydra.lisp.syntax.FunctionDefinition.name field.
java.util.List<Symbol>	params	The parameter list
static Name	PARAMS	Name of the hydra.lisp.syntax.FunctionDefinition.params field.
static Name	REST_PARAM	Name of the hydra.lisp.syntax.FunctionDefinition.restParam field.
Optional<Symbol>	restParam	Optional rest/variadic parameter
static Name	TYPE_	Name of the hydra.lisp.syntax.FunctionDefinition type.
static Name	TYPE_HINTS	Name of the hydra.lisp.syntax.FunctionDefinition.typeHints field.
java.util.List<TypeHint>	typeHints	Optional type hints for parameters and return type

Constructor Summary

Constructors

Constructor	Description
FunctionDefinition(Symbol name, java.util.List<Symbol> params, Optional<Symbol> restParam, Optional<Docstring> doc, java.util.List<TypeHint> typeHints, java.util.List<Expression> body)	Constructs an immutable FunctionDefinition.

Method Summary

Modifier and Type	Method	Description
static FunctionDefinition.Builder	builder()	Creates a new fluent builder for FunctionDefinition.
int	compareTo(FunctionDefinition other)
boolean	equals(java.lang.Object other)
int	hashCode()
java.lang.String	toString()
FunctionDefinition	withBody(java.util.List<Expression> body)	Returns a copy of this FunctionDefinition with body replaced.
FunctionDefinition	withDoc(Optional<Docstring> doc)	Returns a copy of this FunctionDefinition with doc replaced.
FunctionDefinition	withName(Symbol name)	Returns a copy of this FunctionDefinition with name replaced.
FunctionDefinition	withParams(java.util.List<Symbol> params)	Returns a copy of this FunctionDefinition with params replaced.
FunctionDefinition	withRestParam(Optional<Symbol> restParam)	Returns a copy of this FunctionDefinition with restParam replaced.
FunctionDefinition	withTypeHints(java.util.List<TypeHint> typeHints)	Returns a copy of this FunctionDefinition with typeHints 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.lisp.syntax.FunctionDefinition type.

NAME

public static final Name NAME

Name of the hydra.lisp.syntax.FunctionDefinition.name field.

PARAMS

public static final Name PARAMS

Name of the hydra.lisp.syntax.FunctionDefinition.params field.

REST_PARAM

public static final Name REST_PARAM

Name of the hydra.lisp.syntax.FunctionDefinition.restParam field.

DOC

public static final Name DOC

Name of the hydra.lisp.syntax.FunctionDefinition.doc field.

TYPE_HINTS

public static final Name TYPE_HINTS

Name of the hydra.lisp.syntax.FunctionDefinition.typeHints field.

BODY

public static final Name BODY

Name of the hydra.lisp.syntax.FunctionDefinition.body field.

name

public final Symbol name

The function name

params

public final java.util.List<Symbol> params

The parameter list

restParam

public final Optional<Symbol> restParam

Optional rest/variadic parameter

doc

public final Optional<Docstring> doc

Optional docstring

typeHints

public final java.util.List<TypeHint> typeHints

Optional type hints for parameters and return type

body

public final java.util.List<Expression> body

The function body (one or more expressions)

Constructor Detail

FunctionDefinition

public FunctionDefinition(Symbol name,
                          java.util.List<Symbol> params,
                          Optional<Symbol> restParam,
                          Optional<Docstring> doc,
                          java.util.List<TypeHint> typeHints,
                          java.util.List<Expression> body)

Constructs an immutable FunctionDefinition.

Parameters:

name - The function name

params - The parameter list

restParam - Optional rest/variadic parameter

doc - Optional docstring

typeHints - Optional type hints for parameters and return type

body - The function body (one or more expressions)

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

Specified by:

compareTo in interface java.lang.Comparable<FunctionDefinition>

withName

public FunctionDefinition withName(Symbol name)

Returns a copy of this FunctionDefinition with name replaced.

withParams

public FunctionDefinition withParams(java.util.List<Symbol> params)

Returns a copy of this FunctionDefinition with params replaced.

withRestParam

public FunctionDefinition withRestParam(Optional<Symbol> restParam)

Returns a copy of this FunctionDefinition with restParam replaced.

withDoc

public FunctionDefinition withDoc(Optional<Docstring> doc)

Returns a copy of this FunctionDefinition with doc replaced.

withTypeHints

public FunctionDefinition withTypeHints(java.util.List<TypeHint> typeHints)

Returns a copy of this FunctionDefinition with typeHints replaced.

withBody

public FunctionDefinition withBody(java.util.List<Expression> body)

Returns a copy of this FunctionDefinition with body replaced.

builder

public static FunctionDefinition.Builder builder()

Creates a new fluent builder for FunctionDefinition.