capability_type.go

/*
Copyright (c) 2020 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
// your changes will be lost when the file is generated again.

package v1 // github.com/openshift-online/ocm-sdk-go/accountsmgmt/v1

// Capability represents the values of the 'capability' type.
//
// Capability model that represents internal labels with a key that matches a set list defined in AMS (defined in pkg/api/capability_types.go).
type Capability struct {
	bitmap_   uint32
	name      string
	value     string
	inherited bool
}

// Empty returns true if the object is empty, i.e. no attribute has a value.
func (o *Capability) Empty() bool {
	return o == nil || o.bitmap_ == 0
}

// Inherited returns the value of the 'inherited' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Dynamic attribute of the capability that tells us that this capability was inherited from the subscription's organization.
func (o *Capability) Inherited() bool {
	if o != nil && o.bitmap_&1 != 0 {
		return o.inherited
	}
	return false
}

// GetInherited returns the value of the 'inherited' attribute and
// a flag indicating if the attribute has a value.
//
// Dynamic attribute of the capability that tells us that this capability was inherited from the subscription's organization.
func (o *Capability) GetInherited() (value bool, ok bool) {
	ok = o != nil && o.bitmap_&1 != 0
	if ok {
		value = o.inherited
	}
	return
}

// Name returns the value of the 'name' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Name of the capability label.
func (o *Capability) Name() string {
	if o != nil && o.bitmap_&2 != 0 {
		return o.name
	}
	return ""
}

// GetName returns the value of the 'name' attribute and
// a flag indicating if the attribute has a value.
//
// Name of the capability label.
func (o *Capability) GetName() (value string, ok bool) {
	ok = o != nil && o.bitmap_&2 != 0
	if ok {
		value = o.name
	}
	return
}

// Value returns the value of the 'value' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Value that can be assigned to the capability (eg. "true", "false" etc).
func (o *Capability) Value() string {
	if o != nil && o.bitmap_&4 != 0 {
		return o.value
	}
	return ""
}

// GetValue returns the value of the 'value' attribute and
// a flag indicating if the attribute has a value.
//
// Value that can be assigned to the capability (eg. "true", "false" etc).
func (o *Capability) GetValue() (value string, ok bool) {
	ok = o != nil && o.bitmap_&4 != 0
	if ok {
		value = o.value
	}
	return
}

// CapabilityListKind is the name of the type used to represent list of objects of
// type 'capability'.
const CapabilityListKind = "CapabilityList"

// CapabilityListLinkKind is the name of the type used to represent links to list
// of objects of type 'capability'.
const CapabilityListLinkKind = "CapabilityListLink"

// CapabilityNilKind is the name of the type used to nil lists of objects of
// type 'capability'.
const CapabilityListNilKind = "CapabilityListNil"

// CapabilityList is a list of values of the 'capability' type.
type CapabilityList struct {
	href  string
	link  bool
	items []*Capability
}

// Len returns the length of the list.
func (l *CapabilityList) Len() int {
	if l == nil {
		return 0
	}
	return len(l.items)
}

// Empty returns true if the list is empty.
func (l *CapabilityList) Empty() bool {
	return l == nil || len(l.items) == 0
}

// Get returns the item of the list with the given index. If there is no item with
// that index it returns nil.
func (l *CapabilityList) Get(i int) *Capability {
	if l == nil || i < 0 || i >= len(l.items) {
		return nil
	}
	return l.items[i]
}

// Slice returns an slice containing the items of the list. The returned slice is a
// copy of the one used internally, so it can be modified without affecting the
// internal representation.
//
// If you don't need to modify the returned slice consider using the Each or Range
// functions, as they don't need to allocate a new slice.
func (l *CapabilityList) Slice() []*Capability {
	var slice []*Capability
	if l == nil {
		slice = make([]*Capability, 0)
	} else {
		slice = make([]*Capability, len(l.items))
		copy(slice, l.items)
	}
	return slice
}

// Each runs the given function for each item of the list, in order. If the function
// returns false the iteration stops, otherwise it continues till all the elements
// of the list have been processed.
func (l *CapabilityList) Each(f func(item *Capability) bool) {
	if l == nil {
		return
	}
	for _, item := range l.items {
		if !f(item) {
			break
		}
	}
}

// Range runs the given function for each index and item of the list, in order. If
// the function returns false the iteration stops, otherwise it continues till all
// the elements of the list have been processed.
func (l *CapabilityList) Range(f func(index int, item *Capability) bool) {
	if l == nil {
		return
	}
	for index, item := range l.items {
		if !f(index, item) {
			break
		}
	}
}