Packagevegas.util.comparators
Classpublic class ComparableComparator
InheritanceComparableComparator Inheritance CoreObject
ImplementsICloneable, IComparator, ICopyable

A Comparator that compares IComparable objects.


Public Methods
 MethodDefined by
  
ComparableComparator()
Creates a new ComparableComparator instance.
ComparableComparator
  
clone():*
Creates and returns a shallow copy of the object.
ComparableComparator
  
compare(o1:*, o2:*):int
Returns an integer value to compare two objects in parameters.
ComparableComparator
  
copy():*
Creates and returns a deep copy of the object.
ComparableComparator
  
getInstance():ComparableComparator
[static] Returns the singleton instance of a ComparableComparator.
ComparableComparator
 Inherited
getLogger():ILogger
Returns the internal ILogger reference of this ILogable object.
CoreObject
 Inherited
hashCode():uint
Returns a hashcode value for the object.
CoreObject
 Inherited
setLogger(log:ILogger = null):void
Sets the internal ILogger reference of this ILogable object.
CoreObject
 Inherited
toSource(indent:int = 0):String
Returns the string representation the source code of the object.
CoreObject
 Inherited
toString():String
Returns the string representation of this instance.
CoreObject
Constructor detail
ComparableComparator()constructor
public function ComparableComparator()

Creates a new ComparableComparator instance. This constructor whose use should be avoided.

Method detail
clone()method
public function clone():*

Creates and returns a shallow copy of the object.

Returns
* — A new object that is a shallow copy of this instance.
compare()method 
public function compare(o1:*, o2:*):int

Returns an integer value to compare two objects in parameters.

Parameters
o1:* — the first object to compare.
 
o2:* — the second object to compare.

Returns
int —

  • -1 if o1 is "lower" than (less than, before, etc.) o2 ;
  • 1 if o1 is "higher" than (greater than, after, etc.) o2 ;
  • 0 if o1 and o2 are equal.

    		•

    Throws
    — when the o1 object is null or undefined.
     
    — it the o1 object is not a IComparable object.
    copy()method 
    public function copy():*

    Creates and returns a deep copy of the object.

    Returns
    * — A new object that is a deep copy of this instance.
    getInstance()method 
    public static function getInstance():ComparableComparator

    Returns the singleton instance of a ComparableComparator. Developers are encouraged to use the comparator returned from this method instead of constructing a new instance to reduce allocation and GC overhead when multiple comparable comparators may be used in the same application.

    Returns
    ComparableComparator — the singleton instance of a ComparableComparator.