com.partnersoft.cog

Class CogDelta

java.lang.Object

com.partnersoft.cog.CogDelta

All Implemented Interfaces:

Coggable, Immutable

public class CogDelta
extends java.lang.Object
implements Coggable, Immutable

Encapsulates the difference between two cogs.

CogDeltas are composed of individual CogNodeDelta operations. These describe the steps needed to reconstruct the second cog from the first.

Currently, CogDeltas only work for simple, single-level Cogs - Namings, really. It ignores order and ignores case of values.

Copyright 2010 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
CogDelta()
CogDelta(Cog state) This is the constructor to support the Coggable interface.
CogDelta(Cog a, Cog b) This constructor computes the delta between the first and second Cogs.
CogDelta(java.util.List<CogNodeDelta> nodeDeltas)

Method Summary

Methods

Modifier and Type	Method and Description
Cog	appliedTo(Cog original) Returns a new Cog created by applying this delta to the original.
java.util.List<CogNodeDelta>	getNodeDeltas() Read-only access to the node deltas.
boolean	isIdentity() Returns true if this delta contains no changes - and, therefore, applying it returns a matching copy of the input Cog.
java.util.List<CogNodeDelta>	listNodeDeltas() Returns a fresh copy of the node deltas.
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CogDelta

public CogDelta()

CogDelta

public CogDelta(java.util.List<CogNodeDelta> nodeDeltas)

CogDelta

public CogDelta(Cog state)

This is the constructor to support the Coggable interface.

CogDelta

public CogDelta(Cog a,
        Cog b)

This constructor computes the delta between the first and second Cogs.

Method Detail

appliedTo

public Cog appliedTo(Cog original)

Returns a new Cog created by applying this delta to the original. Assuming original here is identical to the cog1 provided in the two-argument CogDelta constructor, the result will be identical to cog2.

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

getNodeDeltas

public java.util.List<CogNodeDelta> getNodeDeltas()

Read-only access to the node deltas.

listNodeDeltas

public java.util.List<CogNodeDelta> listNodeDeltas()

Returns a fresh copy of the node deltas.

isIdentity

public boolean isIdentity()

Returns true if this delta contains no changes - and, therefore, applying it returns a matching copy of the input Cog.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object