Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

com.gentleware.poseidon.uml.generator

Class PreparedParameter


public class PreparedParameter

This class contains the prepared information for a parameter. The information can directly be used in the code generation.
See also:
com.gentleware.poseidon.generator.PreparedElement
com.gentleware.poseidon.generator.ElementPreparator
ModelElementPreparator


 Association Summary
public PreparedOperation  preparedOperation
 
arrow_up
 

 Constructor Summary
public   PreparedParameter()
Creates a new instance. 
public   PreparedParameter( Parameter par , ModelElementPreparator preparator )
Creates a new instance. 
arrow_up
 

 Method Summary
public String   check()
Does a test on the validity of the element. 
protected String   checkType()
 
public String   checkVisibility()
 
public String   getElementType()
Returns the type of the related element as string. 
public String   getFinalAsString()
Gives the Final modifier as String. 
public PreparedClassifier   getPreparedType()
Returns the prepared classifier representing the type of the related parameter. 
public String   getSignature()
Returns the signature of the related parameter as a string. 
public String   getTypeAsString()
Returns the type of the related parameter as string. 
public void   init( Parameter element , ModelElementPreparator preparator )
Initializes this instance. 
public boolean   isFinal()
Tests whether the tagged value "final" is set. 
public boolean   isReturnParameter()
Tests, if the parameter is the return parameter for the owning operation. 
public boolean   isTypePreparedModelElement()
Tests, if parameter type is an already prepared model element. 
arrow_up
 

 

 Association Detail

preparedOperation

public PreparedOperation preparedOperation

 
arrow_up
 

 Constructor Detail

PreparedParameter

public PreparedParameter PreparedParameter()

Creates a new instance. 
arrow_up
 
 

PreparedParameter

public PreparedParameter PreparedParameter( Parameter par , ModelElementPreparator preparator )

Creates a new instance. It will be related to the given model element and handled by the given preparator. The information of the given model element will be prepared here.
Parameters:
element - The model element this instance should be related to.
preparator - The preparator handling this instance.
 
arrow_up
 

 Method Detail

check

public String check()

Does a test on the validity of the element. The test for name, visibility and type are called subsequently.
Returns:
Concatenation of messages occuring while testing this prepared element.
 
arrow_up
 
 

checkType

protected String checkType()

 
arrow_up
 
 

checkVisibility

public String checkVisibility()

 
arrow_up
 
 

getElementType

public String getElementType()

Returns the type of the related element as string.
Returns:
The type of the related element.
 
arrow_up
 
 

getFinalAsString

public String getFinalAsString()

Gives the Final modifier as String.
Returns:
'final ' or ''.
 
arrow_up
 
 

getPreparedType

public PreparedClassifier getPreparedType()

Returns the prepared classifier representing the type of the related parameter.
Returns:
The prepared classifier for the parameter type.
 
arrow_up
 
 

getSignature

public String getSignature()

Returns the signature of the related parameter as a string.
Returns:
The parameter signature as string.
 
arrow_up
 
 

getTypeAsString

public String getTypeAsString()

Returns the type of the related parameter as string.
Returns:
A string representing the type of the related parameter.
 
arrow_up
 
 

init

public void init( Parameter element , ModelElementPreparator preparator )

Initializes this instance. It will be related to the given model element and handled by the given preparator. The information of the given model element will be prepared here.
Parameters:
element - The model element this instance should be related to.
preparator - The preparator handling this instance.
 
arrow_up
 
 

isFinal

public boolean isFinal()

Tests whether the tagged value "final" is set.
Returns:
True iff the parameter is final, i.e. the TV is true.
 
arrow_up
 
 

isReturnParameter

public boolean isReturnParameter()

Tests, if the parameter is the return parameter for the owning operation.
Returns:
True, if the parameter is a return parameter, otherwise false.
 
arrow_up
 
 

isTypePreparedModelElement

public boolean isTypePreparedModelElement()

Tests, if parameter type is an already prepared model element.
Returns:
True.
 
arrow_up
 

Created  2003 - 3 - 4

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2001 Gentleware AG, Vogt-Kölln-Str.30, 22527 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.