Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

Octet Class Reference

#include <coherence/lang/Octet.hpp>

Inherits Primitive< octet_t >, and Comparable.

List of all members.


Detailed Description

An immutable 8-bit unsigned value.
Author:
jh 2008.04.01

Public Types

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

Public Member Functions

virtual int32_t  compareTo (Object::View v) const
  Compare this object with the specified object for order.

Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

It is strongly recommended, but not strictly required, that (x->compareTo(y) == 0) == (x->equals(y)).

Parameters:
v  the Object to be compared
Returns:
a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object
Exceptions:
ClassCastException  if the specified Object's type prevents it from being compared to this Object


Static Public Member Functions

static Handle  valueOf (octet_t b)
  Factory method to produce Octet objects with an optimization that uses cached objects for all relatively-low values.

Static Public Attributes

static const octet_t  MIN_VALUE
  A constant for the minimum representable value.
static const octet_t  MAX_VALUE
  A constant for the maximum representable value.

Member Function Documentation

static Handle valueOf ( octet_t  b  )  [static]

Factory method to produce Octet objects with an optimization that uses cached objects for all relatively-low values.

Parameters:
b  an octet_t
Returns:
an Octet whose value is the passed octet_t

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