org.asn1s.api.type

Interface Type

All Superinterfaces:

Disposable, Ref<Type>, Scoped, Validation

All Known Subinterfaces:

ClassFieldType, ClassType, CollectionOfType, CollectionType, CollectionTypeExtensionGroup, ComponentType, DefinedType, Enumerated, NamedType, TaggedType

public interface Type
extends Ref<Type>, Disposable, Validation, Scoped

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Type.Family

Method Summary

Modifier and Type	Method and Description
void	accept(Scope scope, Ref<Value> valueRef) Accept value, use scope for resolution.
default ElementSetSpecs	asElementSetSpecs() Convert type to value set if possible
Type	copy() Copy this type.
IEncoding	getEncoding(EncodingInstructions instructions) Return type encodings
Type.Family	getFamily() Return type family
default NamedType	getNamedType(String name) Return component type by name
default List<? extends NamedType>	getNamedTypes() Returns list of all named types
default NamedValue	getNamedValue(String name) Return named value by name
default Collection<NamedValue>	getNamedValues()
String	getNamespace()
default Scope	getScope(Scope parentScope) Get type scope
default Type	getSibling() Returns sibling type if any
default boolean	hasConstraint()
default boolean	hasElementSetSpecs() Returns true if this type has value set associated with it.
default boolean	isConstructedValue(Scope scope, Value value)
default boolean	isTagged() Returns true if current type is tagged.
Value	optimize(Scope scope, Ref<Value> valueRef) Optimize value to type native value kind.
void	setNamespace(String namespace)

Methods inherited from interface org.asn1s.api.Ref

resolve

Methods inherited from interface org.asn1s.api.Disposable

dispose

Methods inherited from interface org.asn1s.api.Validation

getState, isDisposed, isValidated, validate

Method Detail

isTagged

default boolean isTagged()

Returns true if current type is tagged. Exactly this instance.

Returns:

boolean

getScope

@NotNull
default Scope getScope(@NotNull
                                Scope parentScope)

Get type scope

Specified by:

getScope in interface Scoped

Parameters:

parentScope - parent scope for new one

Returns:

new scope or parentScope

getSibling

@Nullable
default Type getSibling()

Returns sibling type if any

Returns:

Type

Throws:

IllegalStateException - if type is not validated

accept

void accept(@NotNull
            Scope scope,
            @NotNull
            Ref<Value> valueRef)
     throws ValidationException,
            ResolutionException

Accept value, use scope for resolution. You should chain scopes if this is required for some reason

Parameters:

scope - resolution scope

valueRef - value reference

Throws:

ValidationException - if value is malformed for this type

ResolutionException - if reference was not resolved, or data can not be acquired

See Also:

optimize(Scope, Ref)

optimize

@NotNull
Value optimize(@NotNull
                        Scope scope,
                        @NotNull
                        Ref<Value> valueRef)
                 throws ResolutionException,
                        ValidationException

Optimize value to type native value kind.

Parameters:

scope - the resolution scope

valueRef - the value ref to optimize

Returns:

new object that is default for type

Throws:

ValidationException - if value is malformed for this type

ResolutionException - if reference was not resolved, or data can not be acquired

See Also:

accept(Scope, Ref)

getNamedType

@Nullable
default NamedType getNamedType(@NotNull
                                         String name)

Return component type by name

Parameters:

name - component name

Returns:

Component type based on parent - either class component, or collection component

getNamedTypes

@NotNull
default List<? extends NamedType> getNamedTypes()

Returns list of all named types

Returns:

list of named types

getNamedValue

@Nullable
default NamedValue getNamedValue(@NotNull
                                           String name)

Return named value by name

Parameters:

name - value name

Returns:

named value

getNamedValues

@NotNull
default Collection<NamedValue> getNamedValues()

getFamily

@NotNull
Type.Family getFamily()

Return type family

Returns:

TypeFamily

getEncoding

IEncoding getEncoding(EncodingInstructions instructions)

Return type encodings

Parameters:

instructions - encoding instructions

Returns:

IEncoding

copy

@NotNull
Type copy()

Copy this type. It's state must be None and validation required. This method is used for template handling Template

Returns:

Type

getNamespace

String getNamespace()

setNamespace

void setNamespace(String namespace)

asElementSetSpecs

default ElementSetSpecs asElementSetSpecs()

Convert type to value set if possible

Returns:

ValueSet

hasConstraint

default boolean hasConstraint()

hasElementSetSpecs

default boolean hasElementSetSpecs()

Returns true if this type has value set associated with it.

Returns:

true if may be used as value set

isConstructedValue

default boolean isConstructedValue(Scope scope,
                                   Value value)