getters

Documentation

Index

• Variables
• type Generator
  • func (Generator) CheckFilter() loader.NodeFilter
  • func (g Generator) Generate(ctx *genall.GenerationContext) error
  • func (Generator) Help() *markers.DefinitionHelp
  • func (Generator) RegisterMarkers(into *markers.Registry) error

Variables

var (
	// GetterTypeMarker is associated with a type that's used as the pointer receiver of the getter method
	GetterTypeMarker = markers.Must(markers.MakeDefinition("devfile:getter:generate", markers.DescribesType, struct{}{}))
	// DefaultFieldMarker is associated with a boolean pointer field to indicate the default boolean value
	DefaultFieldMarker = markers.Must(markers.MakeDefinition("devfile:default:value", markers.DescribesField, ""))
)

Types

type Generator

type Generator struct{}

Generator generates getter methods that are used to return values for the boolean pointer fields.

The pointer receiver is determined from the `devfile:getter:generate` annotated type. The method will return the value of the field if it's been set, otherwise it will return the default value specified by the devfile:default:value annotation.

func (Generator) CheckFilter

func (Generator) CheckFilter() loader.NodeFilter

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

Generate generates the artifacts

func (Generator) Help

func (Generator) Help() *markers.DefinitionHelp

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(into *markers.Registry) error

RegisterMarkers registers the markers of the Generator