class Puppet::Parameter::Value

Describes an acceptable value for a parameter or property. An acceptable value is either specified as a literal value or a regular expression. @note this class should be used via the api methods in {Puppet::Parameter} and {Puppet::Property} @api private

Attributes

block[RW]

call[RW]

event[R]

method[RW]

name[R]

options[R]

required_features[RW]

Public Class Methods

new(name) click to toggle source

Initializes the instance with a literal accepted value, or a regular expression. If anything else is passed, it is turned into a String, and then made into a Symbol. @param [Symbol, Regexp, Object] the value to accept, Symbol, a regular expression, or object to convert. @api private

# File lib/puppet/parameter/value.rb, line 40
def initialize(name)
  if name.is_a?(Regexp)
    @name = name
  else
    # Convert to a string and then a symbol, so things like true/false
    # still show up as symbols.
    @name = convert(name)
  end

  @aliases = []

  @call = :instead
end

Public Instance Methods

alias(name) click to toggle source

Adds an alias for this value. Makes the given name be an alias for this acceptable value. @param name [Symbol] the additonal alias this value should be known as @api private

# File lib/puppet/parameter/value.rb, line 17
def alias(name)
  @aliases << convert(name)
end

aliases() click to toggle source

@return [Array<Symbol>] Returns all aliases (or an empty array). @api private

# File lib/puppet/parameter/value.rb, line 24
def aliases
  @aliases.dup
end

event=(value) click to toggle source

Stores the event that our value generates, if it does so. @api private

# File lib/puppet/parameter/value.rb, line 31
def event=(value)
  @event = convert(value)
end

match?(value) click to toggle source

Checks if the given value matches the acceptance rules (literal value, regular expression, or one of the aliases. @api private

# File lib/puppet/parameter/value.rb, line 58
def match?(value)
  if regex?
    return true if name =~ value.to_s
  else
    return(name == convert(value) ? true : @aliases.include?(convert(value)))
  end
end

regex?() click to toggle source

@return [Boolean] whether the accepted value is a regular expression or not. @api private

# File lib/puppet/parameter/value.rb, line 69
def regex?
  @name.is_a?(Regexp)
end