IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Interface IPatternIdentity

All Superinterfaces:
Comparable
All Known Implementing Classes:
PatternIdentity

public interface IPatternIdentity
extends Comparable

Represents the composite unique identity for a pattern as represented by a pattern descriptor.

The components of the identity are the unique identifier (getPatternId) and the version of the pattern (getPatternVersion). Pattern identities are comparable, therefore a total order is imposed on the set of patterns. Make sure that the unique identifier is sufficiently unique to avoid pattern identity overlap.

The classes that implement IPatternIdentity interface should override equals and hashCode to ensure that the semantics for equality of pattern identities is consistent with equals.


Method Summary
 String getPatternId()
          Returns the ID of the pattern descriptor.
 String getPatternVersion()
          Returns the version of the pattern descriptor.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getPatternId

public String getPatternId()
Returns the ID of the pattern descriptor.

Use the getPatternVersion method to retrieve the version of the pattern descriptor.

Returns:
Returns the ID of the pattern descriptor.

getPatternVersion

public String getPatternVersion()
Returns the version of the pattern descriptor.

Use the getPatternId method to retrieve the ID of the pattern descriptor.

Returns:
Returns the version of the pattern descriptor.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.