IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Class PatternServiceUtil

java.lang.Object
  extended bycom.ibm.xtools.patterns.core.PatternServiceUtil

public final class PatternServiceUtil
extends Object

Exposes the operations of the pattern service that are needed in the public application programming interface (API).

To retrieve the pattern descriptor, use the getPatternDescriptor method. Use the getPatternInstanceProvider method to retrieve the provider for the instances of the pattern.


Method Summary
static IPatternDescriptor getPatternDescriptor(IPatternIdentity identity, MultiStatus status)
          Returns the descriptor for the pattern with the given identity.
static AbstractPatternInstanceProvider getPatternInstanceProvider(IPatternDescriptor pattern, MultiStatus status)
          Returns the provider for the instances of the pattern represented by the given pattern descriptor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPatternDescriptor

public static IPatternDescriptor getPatternDescriptor(IPatternIdentity identity,
                                                      MultiStatus status)
Returns the descriptor for the pattern with the given identity.

Parameters:
identity - The identity of the pattern.
status - The status produced by the operation.
Returns:
Returns the descriptor for the requested pattern; it may be null.

getPatternInstanceProvider

public static AbstractPatternInstanceProvider getPatternInstanceProvider(IPatternDescriptor pattern,
                                                                         MultiStatus status)
Returns the provider for the instances of the pattern represented by the given pattern descriptor.

Some patterns may not have an installed or installable plug-in available, in which case the returned IPatternInstanceProvider may be null.

Parameters:
pattern - The pattern definition to be instantiated.
status - The status produced by the operation.
Returns:
Returns the instance provider for the pattern represented by the given pattern descriptor; it may be null.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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