org.asn1s.api.module

Interface Module

All Superinterfaces:

Disposable

public interface Module
extends Disposable

Method Summary

Modifier and Type	Method and Description
void	addDisposable(Disposable disposable) Register disposable
Scope	createScope()
Module	getCoreModule() Return module with core types, like INTEGER, BOOLEAN, REAL, etc.
Collection<String>	getExports() Returns collection of exported symbol's names
String	getModuleName() Returns module name
ModuleReference	getModuleReference() Return module reference
ModuleResolver	getModuleResolver() Return module resolver used by this module
TagMethod	getTagMethod() Returns module tag method
TypeResolver	getTypeResolver()
ValueResolver	getValueResolver()
boolean	hasExports() Returns true of there are any symbols in export list, this method returns false when modules exports all symbols
boolean	isAllTypesExtensible() Returns true if all types are extensible
boolean	isExportAll() Returns true if module exports all symbols
void	setAllTypesExtensible(boolean flag) Allow all types to be extensible
void	setExports(Collection<String> exports)
void	setTagMethod(TagMethod tagMethod)
default void	validate() Validates this module and all its types, values.
void	validate(boolean types, boolean values) Validates this module and all its types, values.

Methods inherited from interface org.asn1s.api.Disposable

dispose

Method Detail

createScope

Scope createScope()

getCoreModule

Module getCoreModule()

Return module with core types, like INTEGER, BOOLEAN, REAL, etc.

Returns:

Module

getModuleResolver

@Nullable
ModuleResolver getModuleResolver()

Return module resolver used by this module

Returns:

ModuleResolver

getTypeResolver

@NotNull
TypeResolver getTypeResolver()

getValueResolver

@NotNull
ValueResolver getValueResolver()

getModuleReference

@NotNull
ModuleReference getModuleReference()

Return module reference

Returns:

ModuleReference

getModuleName

@NotNull
String getModuleName()

Returns module name

Returns:

string

getTagMethod

@NotNull
TagMethod getTagMethod()

Returns module tag method

Returns:

TagMethod

setTagMethod

void setTagMethod(TagMethod tagMethod)

isAllTypesExtensible

boolean isAllTypesExtensible()

Returns true if all types are extensible

Returns:

boolean

hasExports

boolean hasExports()

Returns true of there are any symbols in export list, this method returns false when modules exports all symbols

Returns:

boolean

isExportAll

boolean isExportAll()

Returns true if module exports all symbols

Returns:

boolean

getExports

Collection<String> getExports()

Returns collection of exported symbol's names

Returns:

names

addDisposable

void addDisposable(Disposable disposable)

Register disposable

Parameters:

disposable - a disposable

setAllTypesExtensible

void setAllTypesExtensible(boolean flag)

Allow all types to be extensible

Parameters:

flag - extensible flag

setExports

void setExports(@Nullable
                Collection<String> exports)

validate

default void validate()
               throws ValidationException,
                      ResolutionException

Validates this module and all its types, values.

Throws:

ValidationException - if module itself or any sibling object can not be validated

ResolutionException - if references can not be resolved

validate

void validate(boolean types,
              boolean values)
       throws ValidationException,
              ResolutionException

Validates this module and all its types, values.

Parameters:

types - if types should be validated

values - if values should be validated

Throws:

ValidationException - if module itself or any sibling object can not be validated

ResolutionException - if references can not be resolved