reference

Documentation

Index

• Constants
• Variables
• type ReferenceParameter
  • func New(project string, configType string, config string, property string) *ReferenceParameter
  • func NewWithCoordinate(coordinate coordinate.Coordinate, property string) *ReferenceParameter
  • func (p *ReferenceParameter) Equal(r *ReferenceParameter) bool
  • func (p *ReferenceParameter) GetReferences() []parameter.ParameterReference
  • func (p *ReferenceParameter) GetType() string
  • func (p *ReferenceParameter) ResolveValue(context parameter.ResolveContext) (interface{}, error)
• type UnresolvedReferenceError
  • func (e UnresolvedReferenceError) Error() string

Constants

const ReferenceParameterType = "reference"

ReferenceParameterType specifies the type of the parameter used in config files

Variables

var ReferenceParameterSerde = parameter.ParameterSerDe{
	Serializer:   writeReferenceParameter,
	Deserializer: parseReferenceParameter,
}

Types

type ReferenceParameter

type ReferenceParameter struct {
	parameter.ParameterReference
}

ReferenceParameter is a parameter which evaluates to the value of the referenced parameter.

func New

func New(project string, configType string, config string, property string) *ReferenceParameter

func NewWithCoordinate

func NewWithCoordinate(coordinate coordinate.Coordinate, property string) *ReferenceParameter

func (*ReferenceParameter) Equal

func (p *ReferenceParameter) Equal(r *ReferenceParameter) bool

func (*ReferenceParameter) GetReferences

func (p *ReferenceParameter) GetReferences() []parameter.ParameterReference

func (*ReferenceParameter) GetType

func (p *ReferenceParameter) GetType() string

func (*ReferenceParameter) ResolveValue

func (p *ReferenceParameter) ResolveValue(context parameter.ResolveContext) (interface{}, error)

ResolveValue tries to find the reference in the already resolved entities. if the referenced entity cannot be found (maybe it is missing, or has not been resolved yet), an error is returned.

type UnresolvedReferenceError

type UnresolvedReferenceError struct {
	// define some shared error information
	parameter.ParameterResolveValueError

	// parameter which has not been resolved yet
	parameter.ParameterReference
}

UnresolvedReferenceError is indicating that the referenced parameter cannot be found and hence no value for the parameter been resolved.

func (UnresolvedReferenceError) Error

func (e UnresolvedReferenceError) Error() string