de.vandermeer.skb.categories.dsl.curlybracket

Interface IsScopedID

All Superinterfaces:

CategoryHas, CategoryIs, CategoryWithValue, HasDescription, de.vandermeer.skb.base.Skb_Renderable

All Known Subinterfaces:

IsScopedID_Mutable

All Known Implementing Classes:

IsScopedID_Impl, IsScopedID_Mutable_Impl

public interface IsScopedID
extends CategoryIs, CategoryWithValue, de.vandermeer.skb.base.Skb_Renderable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IsScopedID.PropAttributes Keys for values associated with parts of a scoped name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SEPARATOR Default scope separator

Fields inherited from interface de.vandermeer.skb.categories.CategoryWithValue

comparator

Method Summary

Modifier and Type	Method and Description
Deque<Object>	_value() Returns the value of an IS category.
boolean	contains(Object element) Returns true if the scope contains the given element
Map<Object,Map<IsScopedID.PropAttributes,Object>>	getProperties() Returns all properties of all elements of the scoped ID.
Map<IsScopedID.PropAttributes,Object>	getProperties(Object element) Returns the properties of a specific element of the scoped name
default Deque<Object>	getScope() Returns a copy of the scoped name elements
IsTokentype	getSymbolType(Object element) Returns the symbol type of a scoped name element.
boolean	isEmpty() Tests if the scoped name is empty
Object	peekFirst() Peek the first element of the scoped name.
Map<IsScopedID.PropAttributes,Object>	peekFirstProperties() Returns the properties of the first element of the scoped name
Object	peekLast() Peeks the last element of the scoped name
Map<IsScopedID.PropAttributes,Object>	peekLastProperties() Returns the properties of the last element of the scoped name
int	size() Returns the size of the scoped name, for instance the number of its elements

Methods inherited from interface de.vandermeer.skb.categories.HasDescription

getDescription

Methods inherited from interface de.vandermeer.skb.categories.CategoryWithValue

CAT_TO_VALUE, CAT_TO_VALUESTRING, GET_VALUE, GET_VALUESTRING, toLog

Methods inherited from interface de.vandermeer.skb.base.Skb_Renderable

OBJECT_TO_RENDERABLE_VALUE, render

Field Detail

DEFAULT_SEPARATOR

static final String DEFAULT_SEPARATOR

Default scope separator

See Also:

Constant Field Values

Method Detail

contains

boolean contains(Object element)

Returns true if the scope contains the given element

Parameters:

element - part of the scoped name to test

Returns:

true if the element is part of the scoped name, false otherwise

getProperties

Map<IsScopedID.PropAttributes,Object> getProperties(Object element)

Returns the properties of a specific element of the scoped name

Parameters:

element - element to look for

Returns:

properties, empty if element not part of scoped name

getProperties

Map<Object,Map<IsScopedID.PropAttributes,Object>> getProperties()

Returns all properties of all elements of the scoped ID.

Returns:

elements with properties

getSymbolType

IsTokentype getSymbolType(Object element)

Returns the symbol type of a scoped name element.

Parameters:

element - element to look for

Returns:

symbol type of the element, null if element not in scoped name or no type set

isEmpty

boolean isEmpty()

Tests if the scoped name is empty

Returns:

true if empty, false otherwise

peekFirst

Object peekFirst()

Peek the first element of the scoped name.

Returns:

first element of the scoped name

peekFirstProperties

Map<IsScopedID.PropAttributes,Object> peekFirstProperties()

Returns the properties of the first element of the scoped name

Returns:

properties

peekLast

Object peekLast()

Peeks the last element of the scoped name

Returns:

last element of the scoped name

peekLastProperties

Map<IsScopedID.PropAttributes,Object> peekLastProperties()

Returns the properties of the last element of the scoped name

Returns:

properties

size

int size()

Returns the size of the scoped name, for instance the number of its elements

Returns:

size

getScope

default Deque<Object> getScope()

Returns a copy of the scoped name elements

Returns:

copy of scoped name elements

_value

Deque<Object> _value()

Description copied from interface: CategoryWithValue

Returns the value of an IS category.

Specified by:

_value in interface CategoryWithValue

Returns:

value of an IS category