propertyrel

package
v1.7.0-gts Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2024 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Overview

Package propertyrel contains the implementation for the rel property. All applications are strongly encouraged to use the interface instead of this concrete definition. The interfaces allow applications to consume only the types and properties needed and be independent of the go-fed implementation if another alternative implementation is created. This package is code-generated and subject to the same license as the go-fed tool used to generate it.

This package is independent of other types' and properties' implementations by having a Manager injected into it to act as a factory for the concrete implementations. The implementations have been generated into their own separate subpackages for each vocabulary.

Strongly consider using the interfaces instead of this package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeserializeRelProperty

func DeserializeRelProperty(m map[string]interface{}, aliasMap map[string]string) (vocab.ActivityStreamsRelProperty, error)

DeserializeRelProperty creates a "rel" property from an interface representation that has been unmarshalled from a text or binary format.

func SetManager

func SetManager(m privateManager)

SetManager sets the manager package-global variable. For internal use only, do not use as part of Application behavior. Must be called at golang init time.

Types

type ActivityStreamsRelProperty

type ActivityStreamsRelProperty struct {
	// contains filtered or unexported fields
}

ActivityStreamsRelProperty is the non-functional property "rel". It is permitted to have one or more values, and of different value types.

func NewActivityStreamsRelProperty

func NewActivityStreamsRelProperty() *ActivityStreamsRelProperty

NewActivityStreamsRelProperty creates a new rel property.

func (*ActivityStreamsRelProperty) AppendIRI

func (this *ActivityStreamsRelProperty) AppendIRI(v *url.URL)

AppendIRI appends an IRI value to the back of a list of the property "rel"

func (*ActivityStreamsRelProperty) AppendRFCRfc5988

func (this *ActivityStreamsRelProperty) AppendRFCRfc5988(v string)

AppendRFCRfc5988 appends a rfc5988 value to the back of a list of the property "rel". Invalidates iterators that are traversing using Prev.

func (ActivityStreamsRelProperty) At

At returns the property value for the specified index. Panics if the index is out of bounds.

func (ActivityStreamsRelProperty) Begin

Begin returns the first iterator, or nil if empty. Can be used with the iterator's Next method and this property's End method to iterate from front to back through all values.

func (ActivityStreamsRelProperty) Empty

func (this ActivityStreamsRelProperty) Empty() bool

Empty returns returns true if there are no elements.

func (ActivityStreamsRelProperty) End

End returns beyond-the-last iterator, which is nil. Can be used with the iterator's Next method and this property's Begin method to iterate from front to back through all values.

func (*ActivityStreamsRelProperty) InsertIRI

func (this *ActivityStreamsRelProperty) InsertIRI(idx int, v *url.URL)

Insert inserts an IRI value at the specified index for a property "rel". Existing elements at that index and higher are shifted back once. Invalidates all iterators.

func (*ActivityStreamsRelProperty) InsertRFCRfc5988

func (this *ActivityStreamsRelProperty) InsertRFCRfc5988(idx int, v string)

InsertRFCRfc5988 inserts a rfc5988 value at the specified index for a property "rel". Existing elements at that index and higher are shifted back once. Invalidates all iterators.

func (ActivityStreamsRelProperty) JSONLDContext

func (this ActivityStreamsRelProperty) JSONLDContext() map[string]string

JSONLDContext returns the JSONLD URIs required in the context string for this property and the specific values that are set. The value in the map is the alias used to import the property's value or values.

func (ActivityStreamsRelProperty) KindIndex

func (this ActivityStreamsRelProperty) KindIndex(idx int) int

KindIndex computes an arbitrary value for indexing this kind of value. This is a leaky API method specifically needed only for alternate implementations for go-fed. Applications should not use this method. Panics if the index is out of bounds.

func (ActivityStreamsRelProperty) Len

func (this ActivityStreamsRelProperty) Len() (length int)

Len returns the number of values that exist for the "rel" property.

func (ActivityStreamsRelProperty) Less

func (this ActivityStreamsRelProperty) Less(i, j int) bool

Less computes whether another property is less than this one. Mixing types results in a consistent but arbitrary ordering

func (ActivityStreamsRelProperty) LessThan

LessThan compares two instances of this property with an arbitrary but stable comparison. Applications should not use this because it is only meant to help alternative implementations to go-fed to be able to normalize nonfunctional properties.

func (ActivityStreamsRelProperty) Name

func (this ActivityStreamsRelProperty) Name() string

Name returns the name of this property ("rel") with any alias.

func (*ActivityStreamsRelProperty) PrependIRI

func (this *ActivityStreamsRelProperty) PrependIRI(v *url.URL)

PrependIRI prepends an IRI value to the front of a list of the property "rel".

func (*ActivityStreamsRelProperty) PrependRFCRfc5988

func (this *ActivityStreamsRelProperty) PrependRFCRfc5988(v string)

PrependRFCRfc5988 prepends a rfc5988 value to the front of a list of the property "rel". Invalidates all iterators.

func (*ActivityStreamsRelProperty) Remove

func (this *ActivityStreamsRelProperty) Remove(idx int)

Remove deletes an element at the specified index from a list of the property "rel", regardless of its type. Panics if the index is out of bounds. Invalidates all iterators.

func (ActivityStreamsRelProperty) Serialize

func (this ActivityStreamsRelProperty) Serialize() (interface{}, error)

Serialize converts this into an interface representation suitable for marshalling into a text or binary format. Applications should not need this function as most typical use cases serialize types instead of individual properties. It is exposed for alternatives to go-fed implementations to use.

func (*ActivityStreamsRelProperty) Set

func (this *ActivityStreamsRelProperty) Set(idx int, v string)

Set sets a rfc5988 value to be at the specified index for the property "rel". Panics if the index is out of bounds. Invalidates all iterators.

func (*ActivityStreamsRelProperty) SetIRI

func (this *ActivityStreamsRelProperty) SetIRI(idx int, v *url.URL)

SetIRI sets an IRI value to be at the specified index for the property "rel". Panics if the index is out of bounds.

func (ActivityStreamsRelProperty) Swap

func (this ActivityStreamsRelProperty) Swap(i, j int)

Swap swaps the location of values at two indices for the "rel" property.

type ActivityStreamsRelPropertyIterator

type ActivityStreamsRelPropertyIterator struct {
	// contains filtered or unexported fields
}

ActivityStreamsRelPropertyIterator is an iterator for a property. It is permitted to be a single default-valued value type.

func NewActivityStreamsRelPropertyIterator

func NewActivityStreamsRelPropertyIterator() *ActivityStreamsRelPropertyIterator

NewActivityStreamsRelPropertyIterator creates a new ActivityStreamsRel property.

func (ActivityStreamsRelPropertyIterator) Get

Get returns the value of this property. When IsRFCRfc5988 returns false, Get will return any arbitrary value.

func (ActivityStreamsRelPropertyIterator) GetIRI

GetIRI returns the IRI of this property. When IsIRI returns false, GetIRI will return any arbitrary value.

func (ActivityStreamsRelPropertyIterator) HasAny

HasAny returns true if the value or IRI is set.

func (ActivityStreamsRelPropertyIterator) IsIRI

IsIRI returns true if this property is an IRI.

func (ActivityStreamsRelPropertyIterator) IsRFCRfc5988

func (this ActivityStreamsRelPropertyIterator) IsRFCRfc5988() bool

IsRFCRfc5988 returns true if this property is set and not an IRI.

func (ActivityStreamsRelPropertyIterator) JSONLDContext

func (this ActivityStreamsRelPropertyIterator) JSONLDContext() map[string]string

JSONLDContext returns the JSONLD URIs required in the context string for this property and the specific values that are set. The value in the map is the alias used to import the property's value or values.

func (ActivityStreamsRelPropertyIterator) KindIndex

func (this ActivityStreamsRelPropertyIterator) KindIndex() int

KindIndex computes an arbitrary value for indexing this kind of value. This is a leaky API detail only for folks looking to replace the go-fed implementation. Applications should not use this method.

func (ActivityStreamsRelPropertyIterator) LessThan

LessThan compares two instances of this property with an arbitrary but stable comparison. Applications should not use this because it is only meant to help alternative implementations to go-fed to be able to normalize nonfunctional properties.

func (ActivityStreamsRelPropertyIterator) Name

Name returns the name of this property: "ActivityStreamsRel".

func (ActivityStreamsRelPropertyIterator) Next

Next returns the next iterator, or nil if there is no next iterator.

func (ActivityStreamsRelPropertyIterator) Prev

Prev returns the previous iterator, or nil if there is no previous iterator.

func (*ActivityStreamsRelPropertyIterator) Set

Set sets the value of this property. Calling IsRFCRfc5988 afterwards will return true.

func (*ActivityStreamsRelPropertyIterator) SetIRI

func (this *ActivityStreamsRelPropertyIterator) SetIRI(v *url.URL)

SetIRI sets the value of this property. Calling IsIRI afterwards will return true.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL