Class: NeverBounce::CLI::Feature::Envars::Item

Inherits:

Object

• Object
• NeverBounce::CLI::Feature::Envars::Item

Defined in:

lib/never_bounce/cli/feature/envars/item.rb

Overview

Single envar item container.

Instance Attribute Summary

• #comment ⇒ String
• #default ⇒ mixed

  Default value.

• #examples ⇒ Array

  Value examples.

• #is_mandatory ⇒ bool (also: #mandatory?)

  True if this envar is mandatory.

• #name ⇒ String

Instance Attribute Details

#comment ⇒ String

Returns:

• (String)

# File 'lib/never_bounce/cli/feature/envars/item.rb', line 17

def comment
  @comment
end

#default ⇒ mixed

Default value. Default is nil.

Returns:

• (mixed)

# File 'lib/never_bounce/cli/feature/envars/item.rb', line 23

def default
  igetset(:default) { nil }
end

#examples ⇒ Array

Value examples. Default is [].

Returns:

• (Array)

# File 'lib/never_bounce/cli/feature/envars/item.rb', line 29

def examples
  @examples ||= []
end

#is_mandatory ⇒ bool Also known as: mandatory?

True if this envar is mandatory. Default is false.

Returns:

• (bool)

# File 'lib/never_bounce/cli/feature/envars/item.rb', line 35

def is_mandatory
  igetset(:is_mandatory) { false }
end

#name ⇒ String

Returns:

• (String)

# File 'lib/never_bounce/cli/feature/envars/item.rb', line 14

def name
  @name
end