IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.framework
Class PatternsFrameworkResult

java.lang.Object
  extended bycom.ibm.xtools.patterns.core.AbstractPatternResult
      extended bycom.ibm.xtools.patterns.framework.PatternsFrameworkResult

public class PatternsFrameworkResult
extends AbstractPatternResult

This class provides a default implementation of the AbstractPatternResult class.


Constructor Summary
PatternsFrameworkResult()
          Create an empty pattern result.
PatternsFrameworkResult(Object createdObject)
          Create a pattern result with the given created object.
PatternsFrameworkResult(Object[] createdObjects)
          Create a pattern result with the given created objects.
 
Method Summary
 void addCreatedObject(Object object)
          Add the given object to the created objects of this pattern result.
 void addCreatedObjects(Object[] objects)
          Add the given array of objects to the collection of created objects associated with this pattern result.
 void addNestedResult(AbstractPatternResult nestedResult)
          Add the given result to the nested results of this pattern result.
 Object[] getCreatedObjects()
          Get the created objects, if any, of this pattern result.
 AbstractPatternResult[] getNestedResults()
          Get the nested results, if any, of this pattern result.
 boolean hasCreatedObjects()
          Get the nested results, if any, of this pattern result.
 boolean hasNestedResults()
          Indicate whether this pattern result has any nested results.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PatternsFrameworkResult

public PatternsFrameworkResult()
Create an empty pattern result.


PatternsFrameworkResult

public PatternsFrameworkResult(Object createdObject)
Create a pattern result with the given created object.

Parameters:
createdObject - the object to be added to the collection of created objects associated with this result

PatternsFrameworkResult

public PatternsFrameworkResult(Object[] createdObjects)
Create a pattern result with the given created objects.

Parameters:
createdObjects - the array of objects to be added to the collection of created objects associated with this result
Method Detail

hasNestedResults

public boolean hasNestedResults()
Indicate whether this pattern result has any nested results.

Specified by:
hasNestedResults in class AbstractPatternResult
Returns:
true if the pattern result has nested results; else false

getNestedResults

public AbstractPatternResult[] getNestedResults()
Get the nested results, if any, of this pattern result.

Specified by:
getNestedResults in class AbstractPatternResult
Returns:
the nested results of this pattern result

addNestedResult

public void addNestedResult(AbstractPatternResult nestedResult)
Add the given result to the nested results of this pattern result.

Specified by:
addNestedResult in class AbstractPatternResult

hasCreatedObjects

public boolean hasCreatedObjects()
Get the nested results, if any, of this pattern result.

Specified by:
hasCreatedObjects in class AbstractPatternResult
Returns:
the nested results of this pattern result

getCreatedObjects

public Object[] getCreatedObjects()
Get the created objects, if any, of this pattern result.

Specified by:
getCreatedObjects in class AbstractPatternResult
Returns:
the created objects of this pattern result

addCreatedObject

public void addCreatedObject(Object object)
Add the given object to the created objects of this pattern result.

Specified by:
addCreatedObject in class AbstractPatternResult

addCreatedObjects

public void addCreatedObjects(Object[] objects)
Add the given array of objects to the collection of created objects associated with this pattern result.

Specified by:
addCreatedObjects in class AbstractPatternResult
Parameters:
objects - the array of objects to be added to the collection of created objects

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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