net.sf.jpkgmk.prototype
Class PrototypeEntryCommandInclude

java.lang.Object
  net.sf.jpkgmk.AbstractLineProvider
      net.sf.jpkgmk.prototype.PrototypeEntryCommand
          net.sf.jpkgmk.prototype.PrototypeEntryCommandInclude

All Implemented Interfaces:

LineProvider, PrototypeEntry

public class PrototypeEntryCommandInclude
extends PrototypeEntryCommand

Include command to include another prototype file.

For details refer to http://docs.sun.com/app/docs/doc/817-0406/6mg76ste0?a=view in section "Nesting prototype Files".

Since:

1.0

Version:

$Revision: 2 $ $Date: 2008-08-20 21:14:19 +0200 (Mi, 20 Aug 2008) $

Author:

gommma (gommma AT users.sourceforge.net), Last changed by: $Author: gommma $

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jpkgmk.prototype.PrototypeEntryCommand

PrototypeEntryCommand.PrototypeEntryCommandParser

Constructor Summary

PrototypeEntryCommandInclude(java.lang.String includePath)

Method Summary

void	create(java.io.File basedir, VariableResolver variableResolver) Copies the file of this prototype entry into the target directory
java.util.List<PkgMapEntry>	createPkgMapEntry(java.io.File basedir, VariableResolver variableResolver) Creates the PkgMapEntry objects for this PrototypeEntry.
protected java.lang.String	getCommandLinePart()

Methods inherited from class net.sf.jpkgmk.prototype.PrototypeEntryCommand

getLine, getType, isHasWhitespaceSeparator, resolveFile, setHasWhitespaceSeparator, toString

Methods inherited from class net.sf.jpkgmk.AbstractLineProvider

write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.jpkgmk.LineProvider

write

Constructor Detail

PrototypeEntryCommandInclude

public PrototypeEntryCommandInclude(java.lang.String includePath)

Method Detail

getCommandLinePart

protected java.lang.String getCommandLinePart()

Specified by:

getCommandLinePart in class PrototypeEntryCommand

Returns:

Returns the part of the line that is specific for the implementation of the command. This includes everything after the '! cmdType' string

createPkgMapEntry

public java.util.List<PkgMapEntry> createPkgMapEntry(java.io.File basedir,
                                                     VariableResolver variableResolver)

Description copied from interface: PrototypeEntry

Creates the PkgMapEntry objects for this PrototypeEntry.

Parameters:

basedir - The directory in which the pkgMap entry is located

Returns:

The list of all created PkgMapEntry objects created by this prototype entry. Can be empty.

create

public void create(java.io.File basedir,
                   VariableResolver variableResolver)
            throws java.io.IOException

Description copied from interface: PrototypeEntry

Copies the file of this prototype entry into the target directory

variableResolver - The variable resolver to be used for expanding variables within the paths of this entry

Throws:

java.io.IOException