org.jbind.xml.schema.compiler
Interface IFileInfo

All Known Implementing Classes:
FileInfo

public interface IFileInfo


Method Summary
 IComponent getComponent()
          Gets the component for which this file info was created.
 java.io.File getDestinationDir(java.io.File aRootDir)
          Gets the directory of the file of the generated code.
 java.io.File getDestinationFile(java.io.File aRootDir)
          Gets the file name for the generated code.
 java.lang.String getGeneratedCode()
          Gets the generated code.
 boolean isUpToDate(java.io.Reader aReadere)
          Checks if previous code is up to date.
 void output(java.io.File aRootDir, IConstraintViolations aViolations)
           
 void output(java.lang.String aRootDir, IConstraintViolations aViolations)
           
 boolean overwrite()
          Determines if any previous code is overwritten.
 

Method Detail

getComponent

public IComponent getComponent()
Gets the component for which this file info was created.

Returns:
(required).

getGeneratedCode

public java.lang.String getGeneratedCode()
Gets the generated code. If null is returned then no file is be generated.

Returns:
(optional).

getDestinationFile

public java.io.File getDestinationFile(java.io.File aRootDir)
Gets the file name for the generated code.

Parameters:
aRootDir - (required).
Returns:
(required).

getDestinationDir

public java.io.File getDestinationDir(java.io.File aRootDir)
Gets the directory of the file of the generated code.


overwrite

public boolean overwrite()
Determines if any previous code is overwritten.

Returns:
Returns true iff previous code is overwritten.

isUpToDate

public boolean isUpToDate(java.io.Reader aReadere)
                   throws java.lang.Exception
Checks if previous code is up to date.

Returns:
Returns true iff the previous code is up to date.
Throws:
java.lang.Exception

output

public void output(java.lang.String aRootDir,
                   IConstraintViolations aViolations)

output

public void output(java.io.File aRootDir,
                   IConstraintViolations aViolations)