registry

Documentation

Overview

Package registry implements a registry design pattern to registry object under a given unique ID string, allowing registered objects to be reached later or from anywhere when a global registry instance is used.

Index

• func Add(name string, object interface{}) (err error)
• func Adds(objects Objects) (err error)
• func Get(name string) (object interface{}, err error)
• func IsEmpty() (value bool)
• func IsExist(name string) (value bool)
• func IsExists(names []string) (value bool)
• func Remove(name string)
• func RemoveAll()
• func Removes(names []string)
• func Set(name string, object interface{})
• func Sets(objects Objects)
• func Size() (value int)
• type Names
• type Objects
  • func GetAll() (objects Objects)
  • func Gets(names []string) (objects Objects, err error)
• type Registry
  • func New() *Registry
  • func (r *Registry) Add(name string, object interface{}) error
  • func (r *Registry) Adds(objects Objects) error
  • func (r *Registry) Get(name string) (object interface{}, err error)
  • func (r *Registry) GetAll() Objects
  • func (r *Registry) Gets(names []string) (objects Objects, err error)
  • func (r *Registry) IsEmpty() bool
  • func (r *Registry) IsExist(name string) bool
  • func (r *Registry) IsExists(names []string) bool
  • func (r *Registry) Remove(name string) *Registry
  • func (r *Registry) RemoveAll() *Registry
  • func (r *Registry) Removes(names []string) *Registry
  • func (r *Registry) Set(name string, object interface{}) *Registry
  • func (r *Registry) Sets(objects Objects) *Registry
  • func (r *Registry) Size() int

Functions

func Add

func Add(name string, object interface{}) (err error)

Add adds a new object with a given unique id to registry.

func Adds

func Adds(objects Objects) (err error)

Adds adds new objects with given unique ids to registry.

func Get

func Get(name string) (object interface{}, err error)

Get returns registered object by given name.

func IsEmpty

func IsEmpty() (value bool)

IsEmpty returns true if there are no registered objects, otherwise it returns false.

func IsExist

func IsExist(name string) (value bool)

IsExist returns true if object with given name was registered, otherwise it returns false.

func IsExists

func IsExists(names []string) (value bool)

IsExists returns true if all objects with given names were registered, otherwise it returns false.

func Remove

func Remove(name string)

Remove removes registered object.

func RemoveAll

func RemoveAll()

RemoveAll removes all registered object.

func Removes

func Removes(names []string)

Removes removes registered object.

func Set

func Set(name string, object interface{})

Set sets an object with a given unique id to registry.

func Sets

func Sets(objects Objects)

Sets sets objects with given unique ids to registry.

func Size

func Size() (value int)

Size returns number of registered objects.

Types

type Names

type Names []string

Names defines a list of names.

type Objects

type Objects map[string]interface{}

Objects defines a list of objects.

func GetAll

func GetAll() (objects Objects)

GetAll returns all registered objects.

func Gets

func Gets(names []string) (objects Objects, err error)

Gets returns registered objects by given names.

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry defines a registry object that can register objects.

func New

func New() *Registry

New creates a new registry object.

func (*Registry) Add

func (r *Registry) Add(name string, object interface{}) error

Add adds an object with a given unique id to registry.

func (*Registry) Adds

func (r *Registry) Adds(objects Objects) error

Adds adds new objects with given unique ids to registry.

func (*Registry) Get

func (r *Registry) Get(name string) (object interface{}, err error)

Get returns registered object by given name.

func (*Registry) GetAll

func (r *Registry) GetAll() Objects

GetAll returns all registered objects.

func (*Registry) Gets

func (r *Registry) Gets(names []string) (objects Objects, err error)

Gets returns registered objects by given names.

func (*Registry) IsEmpty

func (r *Registry) IsEmpty() bool

IsEmpty returns true if there are no registered objects, otherwise it returns false.

func (*Registry) IsExist

func (r *Registry) IsExist(name string) bool

IsExist returns true if object with given name was registered, otherwise it returns false.

func (*Registry) IsExists

func (r *Registry) IsExists(names []string) bool

IsExists returns true if all objects with given names were registered, otherwise it returns false.

func (*Registry) Remove

func (r *Registry) Remove(name string) *Registry

Remove removes registered object.

func (*Registry) RemoveAll

func (r *Registry) RemoveAll() *Registry

RemoveAll removes all registered objects.

func (*Registry) Removes

func (r *Registry) Removes(names []string) *Registry

Removes removes registered objects.

func (*Registry) Set

func (r *Registry) Set(name string, object interface{}) *Registry

Set sets an object with a given unique id to registry.

func (*Registry) Sets

func (r *Registry) Sets(objects Objects) *Registry

Sets sets objects with given unique ids to registry.

func (*Registry) Size

func (r *Registry) Size() int

Size returns number of registered objects.