Oracle Coherence for C++ API
Release 3.6.0.0

E15728-01

coherence::lang Namespace Reference


Detailed Description

Provides classes that are fundamental to building applications based on the Coherence for C++ managed object model.


Classes

class  abstract_spec
 Helper for defining an abstract managed class. More...
class  AbstractHeapAnalyzer
 AbstractHeapAnalyzer provides a starting point for writing custom heap analyzers. More...
class  ArithmeticException
 An exception that indicates exceptional condition related to arithmetic operations. More...
class  Array
 A fixed size collection of values, indexed by integer position. More...
class  Boolean
 An immutable boolean value. More...
class  BoxHandle
 A TypedHandle implementation which supports auto-boxing. More...
class  Character16
 An immutable 16-bit Unicode character value. More...
class  Class
 A Class represents a managed object implementation. More...
class  class_spec
 Helper for defining a non-cloneable concrete managed class. More...
class  ClassBasedHeapAnalyzer
 ClassBasedHeapAnalyzer provides heap analysis at the class level, that is it tracks the number of live instances of each class. More...
class  ClassCastException
 Thrown when an attempt is made to cast to an incompatible type. More...
class  ClassLoader
 ClassLoader provides a mechanism for obtaining a Class object. More...
class  ClassNotFoundException
 Thrown when a definition for a named Class could be found. More...
class  cloneable_spec
 Helper for defining a cloneable managed class. More...
class  CloneNotSupportedException
 Thrown when an attempt is made to clone an object which does not support cloning. More...
class  Comparable
 This interface imposes a total ordering on the objects of each class that implements it. More...
class  ConstCastException
 Thrown when an attempt is made to cast away constness from a Holder assigned from a View. More...
class  DetachFinalizer
 Finalizer which detaches from an Object upon deletion. More...
class  Exception
 Base class for all exceptions used in Coherence. More...
class  ExecutableClass
 Interface specialization for Classes which are executable. More...
class  FinalHandle
 FinalHandle is an immutable thread-safe handle used by an Object to reference its non-const child Objects. More...
class  FinalHolder
 FinalHolder is an immutable thread-safe holder intended for use as a data-member within Objects. More...
class  FinalizableBlock
 A finalizable block which runs a series of chained Finalizers as part of its destruction. More...
class  FinalView
 FinalView is an immutable thread-safe view intended for use as a data-member within Objects. More...
class  Float32
 An immutable 32-bit floating-point value. More...
class  Float64
 An immutable 64-bit floating-point value. More...
class  HeapAnalyzer
 HeapAnalyzer provides a base diagnostics interface for tracking heap usage. More...
class  IllegalArgumentException
 Thrown to indicate that a function has been passed an illegal or inappropriate argument. More...
class  IllegalStateException
 Signals that a function has been called at an illegal or inappropriate time. More...
class  Immutable
 A Handle implementation which upon assignment ensures that it will reference an immutable Object. More...
class  IndexOutOfBoundsException
 Thrown to indicate that an index of some sort (such as to an array, to a string, or to a vector) is out of range. More...
class  Integer16
 An immutable 16-bit integer value. More...
class  Integer32
 An immutable 32-bit integer value. More...
class  Integer64
 An immutable 64-bit integer value. More...
class  interface_spec
 Helper for defining a managed interface. More...
class  InterruptedException
 Signals that the current thread has been interrupted. More...
class  implements
 The implements template specifies a list of interfaces which a class or interface specification derives from. More...
class  extends
 The extends template indicates the parent class in a class specification. More...
class  factory
 The factory class auto-generates static create methods for a class, corresponding to the class's constructors. More...
class  Managed
 Managed is an adaptor class which transforms a pre-existing class into a Coherence managed Object. More...
class  MemberHandle
 MemberHandle is a thread-safe handle used by an Object to reference its non-const child Objects. More...
class  MemberHolder
 MemberHolder is a thread-safe handle implementation which supports referencing Objects as either Handles or Views. More...
class  MemberView
 MemberView is a thread-safe view intended for use as a data-member within Objects. More...
class  NoSuchElementException
 Thrown to indicate that a object is not found in the cache/map/collection. More...
class  NullPointerException
 Thrown when an application attempts to use NULL in a case where a non-NULL handle to Object is required. More...
class  Number
 Interface implemented by all managed numeric types. More...
class  Object
 Object is the base class for all Coherence managed objects. More...
class  ObjectCountHeapAnalyzer
 ObjectCountHeapAnalyzer provides simple heap analysis based solely on the count of the number of live objects in the system. More...
class  Octet
 An immutable 8-bit unsigned value. More...
class  OutOfMemoryError
 Thrown to indicate that an attempt to allocate an object failed due to resource constraints. More...
class  Primitive
 Template class which converts primitive data types into immutable managed objects. More...
class  Reference
 Reference provides an additional level of indirection to object instances. More...
class  Runnable
 Interface implemented by any class whose instances are intended to be executed by a thread. More...
class  RuntimeException
 RuntimeException is the superclass for exceptions which are not normally handled by user code. More...
class  SecurityException
 Thrown to indicate a security violation. More...
class  SmartMember
 Base class for smart data-members of managed Objects. More...
class  StackTraceElement
 StackTraceElement interface represents a frame within a stack trace. More...
class  String
 A managed C-style (NUL terminated) string. More...
class  SubscriptHandle
 A TypedHandle implementation which supports automatic delegation of the subscript operator. More...
class  SubscriptHolder
 A TypedHolder implementation which supports automatic delegation of the subscript operator. More...
class  SynchronizedBlock
 The SynchronizedBlock class allows for easy creation of synchronized code blocks based on an Object's monitor. More...
class  SynchronizedMemberReadBlock
 The SynchronizedMemberReadBlock class allows for easy creation of synchronized code blocks based on an Object's member level read/write lock. More...
class  SynchronizedMemberWriteBlock
 The SynchronizedMemberBlock class allows for easy creation of synchronized code blocks based on an Object's member level read/write lock. More...
class  System
 A collection of general purpose utility methods. More...
class  SystemClassLoader
 SystemClassLoader is a ClassLoader implementation based on registration only. More...
class  Thread
 An Object representing a thread of execution. More...
class  ThreadGroup
 ThreadGroup represents a set of threads. More...
class  ThreadLocalReference
 ThreadLocalReferences provide a means to store a Handle to an Object in thread local storage. More...
class  throwable_spec
 Helper for defining a throwable managed class. More...
class  TypedBarrenClass
 TypedBarrenClass provides a templated extension of Class but does not provide a means to instantiate new instances of the class. More...
class  TypedClass
 TypedClass provides a templated implementation of Class. More...
class  TypedExecutableClass
 TypedExecutableClass provides a templated extension of ExecutableClass. More...
class  TypedHandle
 Reference counting "smart pointer" class for use with Coherence managed objects. More...
class  TypedHolder
 A handle implementation which supports referencing Objects as either Handles or Views. More...
class  UnsupportedOperationException
 Thrown to indicate that the requested operation is not supported. More...
class  Volatile
 Template class wraps primitive data types with memory barriers, providing JSR-133 style volatiles. More...
class  WeakHandle
 WeakHandles are a TypedHandle like wrapper around WeakReferences. More...
class  WeakHolder
 WeakHolders are a TypedHolder like wrapper around WeakReferences. More...
class  WeakReference
 WeakReferences allow one Object to safely reference another without blocking it from being destroyed. More...
class  WeakView
 WeakViews are a TypedHandle like wrapper around WeakReferences. More...

Typedefs

typedef Array
< MemberHolder
< Object > > 
ObjectArray
 An array of Objects, referenced as either Handles or Views.

Functions

void coh_throw (Exception::Holder ohE, String::View vsFile, int32_t nLine, String::View vsFunction)
 This helper method is used by COH_THROW to raise the exception, supplying the stack at which it was called.
template<class D, class T>
cast (FinalHandle< T > &h, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the FinalHandle to a the specified handle/view type.
template<class D, class T>
cast (const FinalHandle< T > &h, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the FinalHandle to a the specified handle/view type.
template<class D, class T>
bool instanceof (FinalHandle< T > &h)
 Perform an instanceof check on a FinalHandle.
template<class D, class T>
bool instanceof (const FinalHandle< T > &h)
 Perform an instanceof check on a FinalHandle.
template<class T, class H>
void initialize (FinalHandle< T > &h, H that)
 Initialize the value of a FinalHandle after it is constructed.
template<class D, class T>
cast (FinalHolder< T > &h, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the FinalHolder to a the specified handle/view type.
template<class D, class T>
bool instanceof (FinalHolder< T > &h)
 Perform an instanceof check on a handle or view.
template<class T, class OH>
void initialize (FinalHolder< T > &h, OH that)
 Initialize the value of a FinalHolder after it is constructed.
template<class D, class T>
cast (const FinalView< T > &v, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the FinalView to a the specified handle/view type.
template<class D, class T>
bool instanceof (const FinalView< T > &v)
 Perform an instanceof check on a FinalView.
template<class T, class V>
void initialize (FinalView< T > &h, V that)
 Initialize the value of a FinalView after it is constructed.
template<class T>
T::View immutable_view (const typename T::View &v)
 Return an immutable version of the supplied Object.
std::ostream & operator<< (std::ostream &out, const LifeCycle &nState)
 Output a human-readable description of the LifeCycle to an output stream.
template<class T>
std::ostream & operator<< (std::ostream &out, const Managed< T > &aT)
 Output a human-readable description of the specified Managed<T> to the given stream.
template<class T>
std::ostream & operator<< (std::ostream &out, const MemberHandle< T > &mh)
 Output a human-readable description of the given MemberHandle to the specified stream.
template<class T>
void clear_handle (MemberHandle< T > &mh)
 Assign the specified handle to NULL.
template<class T>
bool is_null (const MemberHandle< T > &mh)
 Return true if the supplied handle equals NULL.
template<class D, class T>
cast (MemberHandle< T > &mh, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the MemberHandle to a the specified handle/view type.
template<class D, class T>
cast (const MemberHandle< T > &mh, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the MemberHandle to a the specified handle/view type.
template<class D, class T>
bool instanceof (MemberHandle< T > &mh)
 Perform an instanceof check on a MemberHandle.
template<class D, class T>
bool instanceof (const MemberHandle< T > &mh)
 Perform an instanceof check on a MemberHandle.
template<class T>
std::ostream & operator<< (std::ostream &out, const MemberHolder< T > &th)
 Output a human-readable description of the given MemberHolder to the specified stream.
template<class T>
void clear_handle (MemberHolder< T > &mh)
 Assign the specified holder to NULL.
template<class T>
bool is_null (const MemberHolder< T > &mh)
 Return true if the supplied holder equals NULL.
template<class D, class T>
cast (const MemberHolder< T > &mh, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the MemberHolder to a the specified handle/view type.
template<class D, class T>
bool instanceof (const MemberHolder< T > &mh)
 Perform an instanceof check on a handle or view.
template<class T>
std::ostream & operator<< (std::ostream &out, const MemberView< T > &mv)
 Output a human-readable description of the given MemberView to the specified stream.
template<class T>
void clear_handle (MemberView< T > &mv)
 Assign the specified holder to NULL.
template<class D, class T>
cast (const MemberView< T > &mv, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the MemberView to a the specified handle/view type.
template<class D, class T>
bool instanceof (const MemberView< T > &mv)
 Perform an instanceof check on a MemberView.
template<class T>
bool is_null (const MemberView< T > &mv)
 Return true if the supplied holder equals NULL.
std::ostream & operator<< (std::ostream &out, const Object &o)
 Output a human-readable description of the specified Object to the given stream.
bool operator== (const Object *cpo, const Object::View &v)
 Object reference equality operator.
bool operator== (const Object::View &v, const Object *cpo)
 Object reference equality operator.
bool operator== (const Object::View &v1, const Object::View &v2)
 Object reference equality operator.
bool operator!= (const Object *cpo, const Object::View &v)
 Object reference inequality operator.
bool operator!= (const Object::View &v, const Object *cpo)
 Object reference inequality operator.
bool operator!= (const Object::View &v1, const Object::View &v2)
 Object reference inequality operator.
template<class E>
coh_get_default_exception ()
 Return an empty std::exception derivative.
template<>
std::exception coh_get_default_exception< std::exception > ()
 Return an empty std::exception derivative.
template<>
std::bad_cast coh_get_default_exception< std::bad_cast > ()
 Return an empty std::exception derivative.
template<>
std::bad_typeid coh_get_default_exception< std::bad_typeid > ()
 Return an empty std::exception derivative.
template<>
std::bad_alloc coh_get_default_exception< std::bad_alloc > ()
 Return an empty std::exception derivative.
template<class T>
std::ostream & operator<< (std::ostream &out, const TypedHandle< T > &v)
 Output a human-readable description of the given TypedHandle<T> to the specified stream.
template<class T>
void clear_handle (TypedHandle< T > &h)
 Assign the specified handle to NULL.
template<class T>
bool is_null (const TypedHandle< T > &h)
 Return true if the supplied handle equals NULL.
template<class D, class T>
cast (const TypedHandle< T > &th, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the TypedHandle to a the specified handle/view type.
template<class DT, class T>
bool instanceof (const TypedHandle< T > &th)
 Perform an instanceof check on a handle or view.
template<class T>
std::ostream & operator<< (std::ostream &out, const TypedHolder< T > &th)
 Output a human-readable description of the given TypedHolder to the specified stream.
template<class T>
void clear_handle (TypedHolder< T > &th)
 Assign the specified holder to NULL.
template<class T>
bool is_null (const TypedHolder< T > &th)
 Return true if the supplied holder equals NULL.
template<class T>
bool is_handle (const TypedHolder< T > &th)
 Return true if the supplied holder contains a handle.
template<class D, class T>
cast (const TypedHolder< T > &th, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the TypedHolder to a the specified handle/view type.
template<class D, class T>
bool instanceof (const TypedHolder< T > &th)
 Perform an instanceof check on a handle or view.
template<class T>
std::ostream & operator<< (std::ostream &out, const WeakHandle< T > &wh)
 Output a human-readable description of the given WeakHandle<T> to the specified stream.
template<class T>
void clear_handle (WeakHandle< T > &wh)
 Assign the specified handle to NULL.
template<class T>
bool is_null (const WeakHandle< T > &wh)
 Return true if the supplied handle equals NULL.
template<class D, class T>
cast (WeakHandle< T > &wh, bool fTest=false)
 Perform a dynamic cast the pointer associated with the WeakHandle to a the specified handle/view type.
template<class D, class T>
cast (const WeakHandle< T > &wh, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the WeakHandle to a the specified handle/view type.
template<class D, class T>
bool instanceof (const WeakHandle< T > &wh)
 Perform an instanceof check on a handle or view.
template<class D, class T>
bool instanceof (WeakHandle< T > &wh)
 Perform an instanceof check on a handle or view.
template<class T>
std::ostream & operator<< (std::ostream &out, const WeakHolder< T > &woh)
 Output a human-readable description of the given WeakHolder<T> to the specified stream.
template<class T>
void clear_handle (WeakHolder< T > &woh)
 Assign the specified handle to NULL.
template<class T>
bool is_null (const WeakHolder< T > &woh)
 Return true if the supplied handle equals NULL.
template<class D, class T>
cast (const WeakHolder< T > &woh, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the WeakHolder to a the specified handle/view type.
template<class D, class T>
bool instanceof (const WeakHolder< T > &woh)
 Perform an instanceof check on a handle or view.
template<class T>
std::ostream & operator<< (std::ostream &out, const WeakView< T > &wv)
 Output a human-readable description of the given WeakView<T> to the specified stream.
template<class T>
void clear_handle (WeakView< T > &wv)
 Assign the specified handle to NULL.
template<class T>
bool is_null (const WeakView< T > &wv)
 Return true if the supplied handle equals NULL.
template<class D, class T>
cast (const WeakView< T > &wv, bool fThrow=true)
 Perform a dynamic cast the pointer associated with the WeakView to a the specified handle/view type.
template<class D, class T>
bool instanceof (const WeakView< T > &wv)
 Perform an instanceof check on a handle or view.


Typedef Documentation

typedef Array<MemberHolder<Object> > ObjectArray

An array of Objects, referenced as either Handles or Views.

This is a typedef of Array<MemberHolder> and as such assignments to the array elements are thread-safe.

See also:
Array
Author:
mf 2008.01.11


Function Documentation

D coherence::lang::cast ( const WeakView< T > &  wv,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the WeakView to a the specified handle/view type.

Parameters:
wv the WeakView from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const WeakHolder< T > &  woh,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the WeakHolder to a the specified handle/view type.

Parameters:
woh the WeakHolder from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const WeakHandle< T > &  wh,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the WeakHandle to a the specified handle/view type.

Parameters:
wh the WeakHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( WeakHandle< T > &  wh,
bool  fTest = false 
) [inline]

Perform a dynamic cast the pointer associated with the WeakHandle to a the specified handle/view type.

Parameters:
wh the WeakHandle from which to perform the cast
fTest true for instanceof style test
Returns:
the casted pointer, or NULL if the cast fails and fTest is true
Exceptions:
ClassCastException if the cast fails and fTest of is false

D coherence::lang::cast ( const TypedHolder< T > &  th,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the TypedHolder to a the specified handle/view type.

Parameters:
th the TypedHolder from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const TypedHandle< T > &  th,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the TypedHandle to a the specified handle/view type.

Parameters:
th the TypedHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow of is true

D coherence::lang::cast ( const MemberView< T > &  mv,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the MemberView to a the specified handle/view type.

Parameters:
mv the MemberView from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const MemberHolder< T > &  mh,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the MemberHolder to a the specified handle/view type.

Parameters:
mh the MemberHolder from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const MemberHandle< T > &  mh,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the MemberHandle to a the specified handle/view type.

Parameters:
mh the MemberHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( MemberHandle< T > &  mh,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the MemberHandle to a the specified handle/view type.

Parameters:
mh the MemberHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const FinalView< T > &  v,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the FinalView to a the specified handle/view type.

Parameters:
v the FinalView from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( FinalHolder< T > &  h,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the FinalHolder to a the specified handle/view type.

Parameters:
h the FinalHolder from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( const FinalHandle< T > &  h,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the FinalHandle to a the specified handle/view type.

Parameters:
h the FinalHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

D coherence::lang::cast ( FinalHandle< T > &  h,
bool  fThrow = true 
) [inline]

Perform a dynamic cast the pointer associated with the FinalHandle to a the specified handle/view type.

Parameters:
h the FinalHandle from which to perform the cast
fThrow true if an exception is to be thrown on a failed cast
Returns:
the casted pointer, or NULL if the cast fails and fThrow is false
Exceptions:
ClassCastException if the cast fails and fThrow is true

void coherence::lang::clear_handle ( WeakView< T > &  wv  )  [inline]

Assign the specified handle to NULL.

Parameters:
wv the handle to clear

void coherence::lang::clear_handle ( WeakHolder< T > &  woh  )  [inline]

Assign the specified handle to NULL.

Parameters:
woh the handle to clear

void coherence::lang::clear_handle ( WeakHandle< T > &  wh  )  [inline]

Assign the specified handle to NULL.

Parameters:
wh the handle to clear

void coherence::lang::clear_handle ( TypedHolder< T > &  th  )  [inline]

Assign the specified holder to NULL.

Parameters:
th the holder to clear

void coherence::lang::clear_handle ( TypedHandle< T > &  h  )  [inline]

Assign the specified handle to NULL.

In most cases h = NULL is sufficient but for some handle types there may be ambiguity which would require knowledge of the Handle type, i.e. hString = (String::Handle) NULL; . While the prior example will work just fine clear_handle(hString) performs the same function without requiring the explicit type cast in user code, and works the same for all handle types.

Parameters:
h the handle to clear

void coherence::lang::clear_handle ( MemberView< T > &  mv  )  [inline]

Assign the specified holder to NULL.

Parameters:
mv the MemberView to clear

void coherence::lang::clear_handle ( MemberHolder< T > &  mh  )  [inline]

Assign the specified holder to NULL.

Parameters:
mh the holder to clear

void coherence::lang::clear_handle ( MemberHandle< T > &  mh  )  [inline]

Assign the specified handle to NULL.

Parameters:
mh the handle to clear

E coherence::lang::coh_get_default_exception (  )  [inline]

Return an empty std::exception derivative.

Returns:
an empty exception.

void coherence::lang::coh_throw ( Exception::Holder  ohE,
String::View  vsFile,
int32_t  nLine,
String::View  vsFunction 
)

This helper method is used by COH_THROW to raise the exception, supplying the stack at which it was called.

If the exception is referenced via a handle the exception's stack will be set prior to being throw. The function is marked with compiler specific (no return) statements, so that any calls to it will suppress the corresponding compiler warnings.

Parameters:
ohE the instance of an exception object to throw
vsFile the current file
nLine the current line
vsFunction the current function

T::View coherence::lang::immutable_view ( const typename T::View &  v  )  [inline]

Return an immutable version of the supplied Object.

If the supplied view does not refer to an immutable Object, then a clone of the original Object is returned.

Parameters:
v view to the Object to return an immutable copy of
Returns:
a view to an immutable version of the supplied Object, or the supplied Object if it was already immutable

void coherence::lang::initialize ( FinalView< T > &  h,
that 
) [inline]

Initialize the value of a FinalView after it is constructed.

A FinalView may be initialized only if the following conditions hold:

Parameters:
h the FinalView to initialize
that the value to initialize this FinalView to

void coherence::lang::initialize ( FinalHolder< T > &  h,
OH  that 
) [inline]

Initialize the value of a FinalHolder after it is constructed.

A FinalHolder may be initialized only if the following conditions hold:

Parameters:
h the FinalHolder to initialize
that the value to initialize this FinalHolder to

void coherence::lang::initialize ( FinalHandle< T > &  h,
that 
) [inline]

Initialize the value of a FinalHandle after it is constructed.

A FinalHandle may be initialized only if the following conditions hold:

Parameters:
h the FinalHandle to initialize
that the value to initialize this FinalHandle to

bool coherence::lang::instanceof ( const WeakView< T > &  wv  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
wv the WeakView from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const WeakHolder< T > &  woh  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
woh the WeakHolder from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( WeakHandle< T > &  wh  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
wh the WeakHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const WeakHandle< T > &  wh  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
wh the WeakHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const TypedHolder< T > &  th  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
th the TypedHolder from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const TypedHandle< T > &  th  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
th the TypedHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const MemberView< T > &  mv  )  [inline]

Perform an instanceof check on a MemberView.

Parameters:
mv the MemberView from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const MemberHolder< T > &  mh  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
mh the MemberHolder from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const MemberHandle< T > &  mh  )  [inline]

Perform an instanceof check on a MemberHandle.

Parameters:
mh the MemberHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( MemberHandle< T > &  mh  )  [inline]

Perform an instanceof check on a MemberHandle.

Parameters:
mh the MemberHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const FinalView< T > &  v  )  [inline]

Perform an instanceof check on a FinalView.

Parameters:
v the FinalView from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( FinalHolder< T > &  h  )  [inline]

Perform an instanceof check on a handle or view.

Parameters:
h the FinalHolder from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( const FinalHandle< T > &  h  )  [inline]

Perform an instanceof check on a FinalHandle.

Parameters:
h the FinalHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::instanceof ( FinalHandle< T > &  h  )  [inline]

Perform an instanceof check on a FinalHandle.

Parameters:
h the FinalHandle from which to perform the test
Returns:
true if the supplied handle is an instance of the specified type

bool coherence::lang::is_handle ( const TypedHolder< T > &  th  )  [inline]

Return true if the supplied holder contains a handle.

Parameters:
th the holder to test
Returns:
true iff the supplied holder contains a handle

bool coherence::lang::is_null ( const WeakView< T > &  wv  )  [inline]

Return true if the supplied handle equals NULL.

Parameters:
wv the weak handle to test
Returns:
true iff the supplied handle equals NULL

bool coherence::lang::is_null ( const WeakHolder< T > &  woh  )  [inline]

Return true if the supplied handle equals NULL.

Parameters:
woh the weak handle to test
Returns:
true iff the supplied handle equals NULL

bool coherence::lang::is_null ( const WeakHandle< T > &  wh  )  [inline]

Return true if the supplied handle equals NULL.

Parameters:
wh the weak handle to test
Returns:
true iff the supplied handle equals NULL

bool coherence::lang::is_null ( const TypedHolder< T > &  th  )  [inline]

Return true if the supplied holder equals NULL.

Parameters:
th the holder to test
Returns:
true iff the supplied holder equals NULL

bool coherence::lang::is_null ( const TypedHandle< T > &  h  )  [inline]

Return true if the supplied handle equals NULL.

Parameters:
h the handle to test
Returns:
true iff the supplied handle equals NULL

bool coherence::lang::is_null ( const MemberView< T > &  mv  )  [inline]

Return true if the supplied holder equals NULL.

Parameters:
mv the MemberView to test
Returns:
true iff the supplied MemberView equals NULL

bool coherence::lang::is_null ( const MemberHolder< T > &  mh  )  [inline]

Return true if the supplied holder equals NULL.

Parameters:
mh the holder to test
Returns:
true iff the supplied holder equals NULL

bool coherence::lang::is_null ( const MemberHandle< T > &  mh  )  [inline]

Return true if the supplied handle equals NULL.

Parameters:
mh the member handle to test
Returns:
true iff the supplied handle equals NULL

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const WeakView< T > &  wv 
) [inline]

Output a human-readable description of the given WeakView<T> to the specified stream.

Parameters:
out the stream used to output the description
wv the WeakView<T> to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const WeakHolder< T > &  woh 
) [inline]

Output a human-readable description of the given WeakHolder<T> to the specified stream.

Parameters:
out the stream used to output the description
woh the WeakHolder<T> to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const WeakHandle< T > &  wh 
) [inline]

Output a human-readable description of the given WeakHandle<T> to the specified stream.

Parameters:
out the stream used to output the description
wh the WeakHandle<T> to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const TypedHolder< T > &  th 
) [inline]

Output a human-readable description of the given TypedHolder to the specified stream.

Parameters:
out the stream used to output the description
th the TypedHolder to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const TypedHandle< T > &  v 
) [inline]

Output a human-readable description of the given TypedHandle<T> to the specified stream.

Parameters:
out the stream used to output the description
v the TypedHandle<T> to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const Object &  o 
)

Output a human-readable description of the specified Object to the given stream.

Parameters:
out the stream used to output the description
o the Object to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const MemberView< T > &  mv 
) [inline]

Output a human-readable description of the given MemberView to the specified stream.

Parameters:
out the stream used to output the description
mv the MemberView to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const MemberHolder< T > &  th 
) [inline]

Output a human-readable description of the given MemberHolder to the specified stream.

Parameters:
out the stream used to output the description
th the MemberHolder to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const MemberHandle< T > &  mh 
) [inline]

Output a human-readable description of the given MemberHandle to the specified stream.

Parameters:
out the stream used to output the description
mh the MemberHandle to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const Managed< T > &  aT 
) [inline]

Output a human-readable description of the specified Managed<T> to the given stream.

Parameters:
out the stream used to output the description
aT the Managed<T> to describe
Returns:
the supplied stream

std::ostream& coherence::lang::operator<< ( std::ostream &  out,
const LifeCycle &  nState 
)

Output a human-readable description of the LifeCycle to an output stream.

Parameters:
out the stream to write the description to
nState the state to write to the stream
Returns:
a reference to the supplied stream

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.