org.eclipse.tigerstripe.profile.primitiveType
Interface IPrimitiveTypeDef


public interface IPrimitiveTypeDef

A primitive type definition as it appears in a profile definition Once the profile is loaded, these are turned into IPrimitiveTypeArtifact that are put into context for all projects

Since:
1.2
Author:
Eric Dillon

Method Summary
 org.dom4j.Element asDefaultElement()
          Returns an XML representation of this primitive type The default element contains package information.
 org.dom4j.Element asElement()
          Returns an XML representation of this stereotype
 java.lang.String getDescription()
           
 java.lang.String getName()
           
 java.lang.String getPackageName()
           
 boolean isRecommendedName()
          used when testing names of primitive types to see if they match the "typical" naming conventions for data types (isRecommendedName returns true if the type name "looks like" a typical classname; isValidName returns true if the type name will result in a parse-able POJO if it is used as a data type)
 boolean isReserved()
           
 boolean isValidName()
           
 void parse(org.dom4j.Element element)
          Parses the details of this from the given XML element
 void setDescription(java.lang.String description)
           
 void setName(java.lang.String name)
           
 void setPackageName(java.lang.String name)
           
 

Method Detail

setName

void setName(java.lang.String name)

getName

java.lang.String getName()

setPackageName

void setPackageName(java.lang.String name)

getPackageName

java.lang.String getPackageName()

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

isReserved

boolean isReserved()

isRecommendedName

boolean isRecommendedName()
used when testing names of primitive types to see if they match the "typical" naming conventions for data types (isRecommendedName returns true if the type name "looks like" a typical classname; isValidName returns true if the type name will result in a parse-able POJO if it is used as a data type)

Returns:

isValidName

boolean isValidName()

asElement

org.dom4j.Element asElement()
Returns an XML representation of this stereotype

Returns:

asDefaultElement

org.dom4j.Element asDefaultElement()
Returns an XML representation of this primitive type The default element contains package information.

Returns:

parse

void parse(org.dom4j.Element element)
           throws TigerstripeException
Parses the details of this from the given XML element

Parameters:
element -
Throws:
TigerstripeException