Class: SBOM::CycloneDX::Field::Base

Inherits:
Object
  • Object
show all
Extended by:
_FieldBaseClass
Defined in:
lib/sbom/cyclone_dx/field.rb,
sig/sbom/cyclone_dx/field.rbs

Direct Known Subclasses

ConstBase, PropBase

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from _FieldBaseClass

coerce

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



21
22
23
 
# File 'lib/sbom/cyclone_dx/field.rb', line 21

def initialize
  raise "Cannot instantiate abstract Field"
end

Class Attribute Details

.const ⇒ Object (readonly)

Returns the value of attribute const.



46
47
48
 
# File 'lib/sbom/cyclone_dx/field.rb', line 46

def const
  @const
end

.field_name ⇒ Object (readonly)

Returns the value of attribute field_name.



46
47
48
 
# File 'lib/sbom/cyclone_dx/field.rb', line 46

def field_name
  @field_name
end

.json_name ⇒ Object (readonly)

Returns the value of attribute json_name.



46
47
48
 
# File 'lib/sbom/cyclone_dx/field.rb', line 46

def json_name
  @json_name
end

.validator ⇒ Object (readonly)

Returns the value of attribute validator.



46
47
48
 
# File 'lib/sbom/cyclone_dx/field.rb', line 46

def validator
  @validator
end

Instance Attribute Details

#errors ⇒ ::Array[::String] (readonly)

Returns the value of attribute errors.

Returns:

  • (::Array[::String]) 


19
20
21
 
# File 'lib/sbom/cyclone_dx/field.rb', line 19

def errors
  @errors
end

#value ⇒ T? (readonly)

Returns the value of attribute value.

Returns:

  • (T, nil) 


19
20
21
 
# File 'lib/sbom/cyclone_dx/field.rb', line 19

def value
  @value
end

Class Method Details

.const? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/sbom/cyclone_dx/field.rb', line 52

def const?
  @const_present
end

.default ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/sbom/cyclone_dx/field.rb', line 56

def default
  # Skip type-checking here because it is already checked, and Steep is cranky about these
  default_value = _ = @default
  return default_value unless default_value.is_a?(Proc)

  default_value.call
end

.default? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/sbom/cyclone_dx/field.rb', line 64

def default?
  @default_present
end

.required? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/sbom/cyclone_dx/field.rb', line 48

def required?
  validator.required?
end

Instance Method Details

#const ⇒ T?

Returns:

  • (T, nil) 


43
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 43

def const: -> T?

#const? ⇒ Boolean

Returns:

  • (Boolean) 


44
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 44

def const?: -> bool

#default ⇒ T?

Returns:

  • (T, nil) 


45
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 45

def default: -> T?

#default? ⇒ Boolean

Returns:

  • (Boolean) 


46
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 46

def default?: -> bool

#field_name ⇒ Symbol

Returns:

  • (Symbol) 


39
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 39

def field_name: -> Symbol

#json_name ⇒ String

Returns:

  • (String) 


41
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 41

def json_name: -> String

#required? ⇒ Boolean

Returns:

  • (Boolean) 


42
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 42

def required?: -> bool

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
32
 
# File 'lib/sbom/cyclone_dx/field.rb', line 29

def valid?
  @errors = validator.validate(value)
  @errors.empty?
end

#validator ⇒ Validator::BaseValidator[T]

Returns:



40
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 40

def validator: -> Validator::BaseValidator[T]

#value= ⇒ void (readonly)

This method returns an undefined value.

Parameters:

  • (T, nil) 


35
 
# File 'sig/sbom/cyclone_dx/field.rbs', line 35

def value=: (T?) -> void

#value? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/sbom/cyclone_dx/field.rb', line 25

def value?
  @value.nil?
end