Class: SBOM::CycloneDX::Record::Note

Inherits:

Base

• Object
• Base
• SBOM::CycloneDX::Record::Note

Defined in:

lib/sbom/cyclone_dx/record/note.rb,
sig/sbom/cyclone_dx/record/note.rbs

Overview

Schema name: Note

Constant Summary

Constants inherited from Base

Base::Record

Instance Attribute Summary

Attributes inherited from Base

#errors

Instance Method Summary

• #initialize ⇒ Note constructor

  A new instance of Note.

• #locale ⇒ String^?
• #locale= ⇒ String^?
• #locale? ⇒ Boolean
• #locale_valid? ⇒ Boolean
• #text ⇒ Attachment
• #text= ⇒ Attachment
• #text? ⇒ Boolean
• #text_valid? ⇒ Boolean

Methods inherited from Base

#<=>, const, custom_validators, fields, #formatted_errors, json_create, json_name, prop, #valid!, #valid?, validate

Methods included from _Klass

#const, #const_names, #create, #create!, #custom_validators, #fields, #json_name, #prop, #prop_names, #validate

Methods included from _Instance

#as_json, #errors, #formatted_errors, #to_json, #valid?

Constructor Details

#initialize ⇒ Note

Returns a new instance of Note.

Parameters:

• locale: (String, nil)
• text: (Attachment)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 5

def initialize: (?locale: String?, text: Attachment) -> void

Instance Method Details

#locale ⇒ String^?

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 7

def locale: () -> String?

#locale= ⇒ String^?

Parameters:

• (String, nil)

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 8

def locale=: (String?) -> String?

#locale? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 9

def locale?: () -> bool

#locale_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 10

def locale_valid?: () -> bool

#text ⇒ Attachment

Returns:

• (Attachment)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 12

def text: () -> Attachment

#text= ⇒ Attachment

Parameters:

• (Attachment)

Returns:

• (Attachment)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 13

def text=: (Attachment) -> Attachment

#text? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 14

def text?: () -> bool

#text_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/note.rbs', line 15

def text_valid?: () -> bool