Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.3.0)
E80355-01
coherence::util::ThreadGate::Counter

ThreadGate::Counter Class Reference

#include <coherence/util/ThreadGate.hpp>

Inherits Object.

List of all members.

Detailed Description

Counter is a mutable integer class.

Public Types

typedef spec::Handle Handle
 Counter Handle definition.
typedef spec::View View
 Counter View definition.
typedef spec::Holder Holder
 Counter Holder definition.

Public Member Functions

virtual int32_t getCount () const
 Return the count.
virtual void setCount (int32_t c)
 Set the count.
virtual int32_t increment ()
 Increment the count by 1.
virtual int32_t decrement ()
 Decrement the count.
virtual TypedHandle
< const String > 		toString () const
 Output a human-readable description of this Object to the given stream.

Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents and is generally how toString() will be implemented.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::View vs = COH_TO_STRING(vKey << " = " << vValue);

The COH_TO_STRING macro is also the most common way to implement the toString method. For example:

 virtual TypedHandle<const String> Person::toString() const
     {
     return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN);
     }

Returns:
a string representation of this object


Protected Member Functions

 Counter (int32_t c=0)
 Create a Counter initialized with a specified value.

Constructor & Destructor Documentation

Counter ( int32_t  c = 0  )  [protected]

Create a Counter initialized with a specified value.

Parameters:
c the initial value of the Counter

Member Function Documentation

virtual int32_t getCount (  )  const [virtual]

Return the count.

Returns:
the count

virtual void setCount ( int32_t  c  )  [virtual]

Set the count.

Parameters:
c the value to set the count to.

virtual int32_t increment (  )  [virtual]

Increment the count by 1.

Returns:
the incremented count.

virtual int32_t decrement (  )  [virtual]

Decrement the count.

Returns:
the decremented count.

The documentation for this class was generated from the following file:
Copyright © 2000, 2017, Oracle and/or its affiliates. All rights reserved.