install4j API documentation


com.install4j.api.context
Interface FileSetSetup


public interface FileSetSetup

This interface provides information about file sets. File sets are configured on the "Define Distribution Tree" tab in the install4j IDE.

Objects of this type are returned by Context.getFileSets() and Context.getFileSetById(String)

Author:
ej-technologies GmbH

Method Summary
 java.lang.String getId()
          The ID of the file set.
 java.lang.String getName()
          Returns the name of this file set.
 boolean isSelected()
          Returns whether the file set is selected for installation.
 void setSelected(boolean selected)
          Sets whether the file set should be installed or not.
 

Method Detail

isSelected

boolean isSelected()
Returns whether the file set is selected for installation. By default, all file sets will be installed.

Returns:
true or false.

setSelected

void setSelected(boolean selected)
Sets whether the file set should be installed or not. This method only has an effect when called before the "Install files" action.

Parameters:
selected - the new selection state

getName

java.lang.String getName()
Returns the name of this file set. This is the name that you have specified in the install4j IDE.

Returns:
the name

getId

java.lang.String getId()
The ID of the file set. You can display component IDs in the install4j IDE.

Returns:
the ID