coins.driver
Class Suffix

java.lang.Object
  extended bycoins.driver.Suffix

public class Suffix
extends java.lang.Object

An object of this class represents a `suffix rule' of a suffix. Using the object, whether a certain pass (preprocessing, compilation and assemble) should be applied to a source file with the suffix or not can be inspeced and a suffix of output file after the pass can be obtained.
There is no public constructor of this class. Use class SuffixFactory to obtain an instance.


Field Summary
(package private)  boolean fIsAssembleRequired
           
(package private)  boolean fIsCompileRequired
           
(package private)  boolean fIsPreprocessRequired
           
 
Constructor Summary
(package private) Suffix(java.lang.String pSuffixString, java.lang.String pSuffixOption, java.lang.String pLanguageName, java.lang.String pDescription, java.lang.String pAfterPreprocess, java.lang.String pAfterCompile, java.lang.String pAfterAssemble, boolean pIsPreprocessRequired, boolean pIsCompileRequired, boolean pIsAssembleRequired)
           
 
Method Summary
 Suffix afterAssemble()
          Returns a suffix of output file after assembling of a file with this suffix.
 Suffix afterCompile()
          Returns a suffix of output file after compilation of a file with this suffix.
 Suffix afterPreprocess()
          Returns a suffix of output file after preprocessing a file with this suffix.
(package private)  void checkIntegrity(CompileSpecification pSpec)
          Checks integrity conditions of this object.
 java.lang.String getDescription()
          Returns a description of this suffix.
 java.lang.String getLanguageName()
          Returns a name of a programming language in which the file of this suffix is written.
 java.lang.String getSuffixOption()
          Returns a suffix option, specified to this suffix rule.
 boolean isAssembleRequired()
          Tests if an assembling is required for a source file with this suffix.
 boolean isCompileRequired()
          Tests if a compilation is required for a source file with this suffix.
 boolean isPreprocessRequired()
          Tests if a preprocessing is required for a source file with this suffix.
 java.lang.String toString()
          Returns a string representation of this suffix.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fIsPreprocessRequired

boolean fIsPreprocessRequired

fIsCompileRequired

boolean fIsCompileRequired

fIsAssembleRequired

boolean fIsAssembleRequired
Constructor Detail

Suffix

Suffix(java.lang.String pSuffixString,
       java.lang.String pSuffixOption,
       java.lang.String pLanguageName,
       java.lang.String pDescription,
       java.lang.String pAfterPreprocess,
       java.lang.String pAfterCompile,
       java.lang.String pAfterAssemble,
       boolean pIsPreprocessRequired,
       boolean pIsCompileRequired,
       boolean pIsAssembleRequired)
Method Detail

getDescription

public java.lang.String getDescription()
Returns a description of this suffix.

Returns:
a description of this suffix.

getLanguageName

public java.lang.String getLanguageName()
Returns a name of a programming language in which the file of this suffix is written.

Returns:
a programming language name

getSuffixOption

public java.lang.String getSuffixOption()
Returns a suffix option, specified to this suffix rule. If no suffix option is specified, null is returned.

Returns:
suffix option, or null if not specified.

afterPreprocess

public Suffix afterPreprocess()
Returns a suffix of output file after preprocessing a file with this suffix.

Returns:
a suffix of preprocessed file.

afterCompile

public Suffix afterCompile()
Returns a suffix of output file after compilation of a file with this suffix.

Returns:
a suffix of compiled file.

afterAssemble

public Suffix afterAssemble()
Returns a suffix of output file after assembling of a file with this suffix.

Returns:
a suffix of assembled file.

isPreprocessRequired

public boolean isPreprocessRequired()
Tests if a preprocessing is required for a source file with this suffix.

Returns:
true if a preprocessing is required, false otherwise.

isCompileRequired

public boolean isCompileRequired()
Tests if a compilation is required for a source file with this suffix.

Returns:
true if a compilation is required, false otherwise.

isAssembleRequired

public boolean isAssembleRequired()
Tests if an assembling is required for a source file with this suffix.

Returns:
true if an assembling is required, false otherwise.

toString

public java.lang.String toString()
Returns a string representation of this suffix.

Returns:
a string representation of this suffix.

checkIntegrity

void checkIntegrity(CompileSpecification pSpec)
Checks integrity conditions of this object.

Parameters:
pSpec - a CompileSpecification object.