LightJason - AgentSpeak(L++)
org.lightjason.agentspeak.language.variable.CRelocateVariable< T > Class Template Reference

class for a relocated variable More...

+ Inheritance diagram for org.lightjason.agentspeak.language.variable.CRelocateVariable< T >:
+ Collaboration diagram for org.lightjason.agentspeak.language.variable.CRelocateVariable< T >:

Public Member Functions

 CRelocateVariable (final IVariable<?> p_variable)
 ctor More...
 
 CRelocateVariable ( @Nonnull final IPath p_functor, @Nonnull final IVariable<?> p_relocate)
 ctor More...
 
final ITerm deepcopy (final IPath... p_prefix)
 
final ITerm deepcopysuffix ()
 
final IVariable<?> relocate ()
 sets the value into the relocated variable and returns the modifed variable More...
 
final IVariable< T > shallowcopy (final IPath... p_prefix)
 
final IVariable< T > shallowcopysuffix ()
 clones the object (shallow-copy) without full-qualified path, only suffix is used More...
 
String toString ()
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.variable.CVariable< T >
 CVariable ( @Nonnull final String p_functor)
 ctor More...
 
 CVariable ( @Nonnull final String p_functor, @Nullable final T p_value)
 ctor More...
 
 CVariable ( @Nonnull final IPath p_functor)
 ctor More...
 
 CVariable ( @Nonnull final IPath p_functor, @Nullable final T p_value)
 ctor More...
 
boolean allocated ()
 returns allocated state More...
 
final boolean any ()
 flag to define a "any variable" More...
 
ITerm deepcopy (final IPath... p_prefix)
 
ITerm deepcopysuffix ()
 
final boolean equals (final Object p_object)
 
final IPath fqnfunctor ()
 returns the full-qualified functor with path and name More...
 
final String functor ()
 returns the functor without path More...
 
final IPath functorpath ()
 returns the path of the functor More...
 
final int hashCode ()
 
final boolean hasVariable ()
 checks if the literal has variables More...
 
boolean mutex ()
 flag to check if variable has is concurrency- / thread-safe More...
 
IVariable< T > set ( @Nullable final T p_value)
 sets the value More...
 
IVariable< T > shallowcopy (final IPath... p_prefix)
 
IVariable< T > shallowcopysuffix ()
 clones the object (shallow-copy) without full-qualified path, only suffix is used More...
 
final int structurehash ()
 returns a hash value which defines a hash ove rthe structure More...
 
IVariable< T > thrownotallocated () throws IllegalStateException
 throws an illegal state exception iif the variable is not allocated More...
 
IVariable< T > throwvaluenotassignableto ( @Nonnull final Class<?>... p_class) throws IllegalArgumentException
 throws an illegal argument exception iif the value is not assignable to the class More...
 
String toString ()
 
boolean valueassignableto ( @Nonnull final Class<?>... p_class)
 checkes assignable of the value More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.ITerm
default< T extends ITerm > T term ()
 casts the object to a term-type More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.IDeepCopy< ITerm >
deepcopy (@Nullable final IPath... p_prefix)
 clones the object (shallow-copy) More...
 
deepcopysuffix ()
 clones the object (shallow-copy) without full-qualified path, only suffix is used More...
 
- Public Member Functions inherited from org.lightjason.agentspeak.language.IShallowCopy< T >
shallowcopy ( @Nullable final IPath... p_prefix)
 clones the object (shallow-copy) More...
 

Private Member Functions

 CRelocateVariable ( @Nonnull final IPath p_functor, @Nonnull final IVariable<?> p_variable, @Nullable final T p_value)
 private ctor for creating object-copy More...
 

Private Attributes

final IVariable<?> m_relocate
 reference to relocated variable More...
 

Static Private Attributes

static final long serialVersionUID = 2204692497385064257L
 serial id More...
 

Additional Inherited Members

- Public Attributes inherited from org.lightjason.agentspeak.language.ITerm
ITerm EMPTY
 empty term More...
 
long serialVersionUID = -3640918490398129717L
 serial id More...
 
- Public Attributes inherited from org.lightjason.agentspeak.language.IStructureHash
Comparator< IStructureHashCOMPARATOR = Comparator.comparingInt( IStructureHash::structurehash )
 comparator More...
 
- Protected Attributes inherited from org.lightjason.agentspeak.language.variable.CVariable< T >
final boolean m_any
 boolean flag, that defines an variable which matchs always More...
 
final IPath m_functor
 variable / functor name More...
 
m_value
 value of the variable More...
 
- Package Functions inherited from org.lightjason.agentspeak.language.variable.CVariable< T >
public< N > N raw ()
 cast to any raw value type More...
 

Detailed Description

Template Parameters
Tvariable type

Definition at line 42 of file CRelocateVariable.java.

Constructor & Destructor Documentation

◆ CRelocateVariable() [1/3]

Parameters
p_variablevariable which should be reloacted

Definition at line 59 of file CRelocateVariable.java.

◆ CRelocateVariable() [2/3]

org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.CRelocateVariable ( @Nonnull final IPath  p_functor,
@Nonnull final IVariable<?>  p_relocate 
)
Parameters
p_functorvariable name
p_relocatevariable which should be relocated

Definition at line 70 of file CRelocateVariable.java.

◆ CRelocateVariable() [3/3]

org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.CRelocateVariable ( @Nonnull final IPath  p_functor,
@Nonnull final IVariable<?>  p_variable,
@Nullable final T  p_value 
)
private
Parameters
p_functorfunctor
p_variablereferenced variable
p_valuevalue

Definition at line 82 of file CRelocateVariable.java.

Member Function Documentation

◆ deepcopy()

final ITerm org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.deepcopy ( final IPath...  p_prefix)

Definition at line 116 of file CRelocateVariable.java.

References org.lightjason.agentspeak.common.IPath.append(), org.lightjason.agentspeak.language.variable.CVariable< T >.m_functor, org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.m_relocate, and org.lightjason.agentspeak.language.variable.CVariable< T >.m_value.

+ Here is the call graph for this function:

◆ deepcopysuffix()

Definition at line 128 of file CRelocateVariable.java.

References org.lightjason.agentspeak.common.CPath.from(), org.lightjason.agentspeak.language.variable.CVariable< T >.m_functor, org.lightjason.agentspeak.language.variable.CVariable< T >.m_value, and org.lightjason.agentspeak.common.IPath.suffix().

+ Here is the call graph for this function:

◆ relocate()

Returns
relocated variable

Implements org.lightjason.agentspeak.language.variable.IRelocateVariable.

Definition at line 90 of file CRelocateVariable.java.

References org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.m_relocate, org.lightjason.agentspeak.language.variable.CVariable< T >.raw(), and org.lightjason.agentspeak.language.variable.IVariable< T >.set().

+ Here is the call graph for this function:

◆ shallowcopy()

◆ shallowcopysuffix()

◆ toString()

Member Data Documentation

◆ m_relocate

◆ serialVersionUID

final long org.lightjason.agentspeak.language.variable.CRelocateVariable< T >.serialVersionUID = 2204692497385064257L
staticprivate

Definition at line 47 of file CRelocateVariable.java.