Profile (Grace Framework

```
public interface Profile
```
A Profile defines an active code generation and command execution policy. For example the "web" profile allows the execution of code gen and build commands that relate to web applications
Authors:
Graeme Rocher
Lari Hotari
Michael Yan
Since:
3.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public Set<String>`	`getBinaryExtensions()` Returns: The list of file extensions which should be treated as binary
	`public List<String>`	`getBuildMergeProfileNames()` Returns: The profile names to participate in build merge
	`public List<String>`	`getBuildPlugins()` Returns: The list of build plugins for this profile
	`public List<String>`	`getBuildRepositories()` Returns: The buildscript maven repository definitions for this profile
	`public Command`	`getCommand(ProjectContext context, String name)` Obtain a command by name
	`public Iterable<Command>`	`getCommands(ProjectContext context)` The profile Command instances
	`public Iterable<jline.console.completer.Completer>`	`getCompleters(ProjectContext context)` The profile completers
	`public NavigableMap`	`getConfiguration()` Returns: The profiles configuration
	`public Iterable<Feature>`	`getDefaultFeatures()` Returns: The default features for this profile
	`public List<Dependency>`	`getDependencies()` Returns: The dependency definitions for this profile
	`public String`	`getDescription()` Returns: The description of the profile
	`public Set<String>`	`getExecutablePatterns()` Returns: The list of file patterns which should be executable in the resulting application
	`public Iterable<Profile>`	`getExtends()` The other Profile instances that this Profile extends
	`public Iterable<Feature>`	`getFeatures()` Returns: The features for this profile
	`public String`	`getInstructions()` Returns: Text to display after an application has been created with the profile
	`public List<Command>`	`getInternalCommands()` The profile's internal Command instances
	`public Iterable<Feature>`	`getInternalFeatures()` Returns: The internal features for this profile
	`public String`	`getName()` Returns: The name of the profile
	`public String`	`getParentSkeletonDir()` Returns: The subfolder the parent profile(s) skeleton should be copied into
	`public File`	`getParentSkeletonDir(File parent)` Returns: The directory the parent profile(s) skeleton should be copied into
	`public Resource`	`getProfileDir()` Returns: The directory where the profile is located locally
	`public List<String>`	`getRepositories()` Returns: The maven repository definitions for this profile
	`public Iterable<Feature>`	`getRequiredFeatures()` Returns: The required features for this profile
	`public List<String>`	`getSkeletonExcludes()` Returns: A list of paths to exclude from the skeleton.
	`public Resource`	`getTemplate(String path)` Obtain a template by path
	`public String`	`getVersion()` Returns: The version of the profile
	`public boolean`	`handleCommand(ExecutionContext context)` Obtains a Command
	`public boolean`	`hasCommand(ProjectContext context, String name)` Whether a command executes for the given context and name

- Method Detail
  - public Set<String> getBinaryExtensions()
    
    Returns:
    The list of file extensions which should be treated as binary
  - public List<String> getBuildMergeProfileNames()
    
    Returns:
    The profile names to participate in build merge
  - public List<String> getBuildPlugins()
    
    Returns:
    The list of build plugins for this profile
  - public List<String> getBuildRepositories()
    
    Returns:
    The buildscript maven repository definitions for this profile
  - public Command getCommand(ProjectContext context, String name)
    
    Obtain a command by name
    Parameters:
    name - Obtain a command by name
    Returns:
    The command
  - public Iterable<Command> getCommands(ProjectContext context)
    
    The profile Command instances
    Parameters:
    context - The ProjectContext instance
    Returns:
    An Iterable of Command instances
  - public Iterable<jline.console.completer.Completer> getCompleters(ProjectContext context)
    
    The profile completers
    Parameters:
    context - The ProjectContext instance
    Returns:
    An Iterable of jline.console.completer.Completer instances
  - public NavigableMap getConfiguration()
    
    Returns:
    The profiles configuration
  - public Iterable<Feature> getDefaultFeatures()
    
    Returns:
    The default features for this profile
  - public List<Dependency> getDependencies()
    
    Returns:
    The dependency definitions for this profile
  - public String getDescription()
    
    Returns:
    The description of the profile
  - public Set<String> getExecutablePatterns()
    
    Returns:
    The list of file patterns which should be executable in the resulting application
  - public Iterable<Profile> getExtends()
    
    The other Profile instances that this Profile extends
    Returns:
    zero or many Profile instance that this profile extends from
  - public Iterable<Feature> getFeatures()
    
    Returns:
    The features for this profile
  - public String getInstructions()
    
    Returns:
    Text to display after an application has been created with the profile
  - public List<Command> getInternalCommands()
    
    The profile's internal Command instances
    Returns:
    A list of Command instances
  - public Iterable<Feature> getInternalFeatures()
    
    Returns:
    The internal features for this profile
  - public String getName()
    
    Returns:
    The name of the profile
  - public String getParentSkeletonDir()
    
    Returns:
    The subfolder the parent profile(s) skeleton should be copied into
  - public File getParentSkeletonDir(File parent)
    
    Returns:
    The directory the parent profile(s) skeleton should be copied into
  - public Resource getProfileDir()
    
    Returns:
    The directory where the profile is located locally
  - public List<String> getRepositories()
    
    Returns:
    The maven repository definitions for this profile
  - public Iterable<Feature> getRequiredFeatures()
    
    Returns:
    The required features for this profile
  - public List<String> getSkeletonExcludes()
    
    Returns:
    A list of paths to exclude from the skeleton. Used in ant fileset exclude:
  - public Resource getTemplate(String path)
    
    Obtain a template by path
    Parameters:
    path - The path to template
    Returns:
    The resource or null if it doesn't exist
  - public String getVersion()
    
    Returns:
    The version of the profile
  - public boolean handleCommand(ExecutionContext context)
    
    Obtains a Command
    Returns:
    True if the command was handled
  - public boolean hasCommand(ProjectContext context, String name)
    
    Whether a command executes for the given context and name
    Parameters:
    context - The ProjectContext
    name - The command name
    Returns:
    True if the command does exist

Summary:
Method

| Detail:
Method

[Java] Interface Profile

Methods Summary

Method Detail

public Set<String> getBinaryExtensions()

public List<String> getBuildMergeProfileNames()

public List<String> getBuildPlugins()

public List<String> getBuildRepositories()

public Command getCommand(ProjectContext context, String name)

public Iterable<Command> getCommands(ProjectContext context)

public Iterable<jline.console.completer.Completer> getCompleters(ProjectContext context)

public NavigableMap getConfiguration()

public Iterable<Feature> getDefaultFeatures()

public List<Dependency> getDependencies()

public String getDescription()

public Set<String> getExecutablePatterns()

public Iterable<Profile> getExtends()

public Iterable<Feature> getFeatures()

public String getInstructions()

public List<Command> getInternalCommands()

public Iterable<Feature> getInternalFeatures()

public String getName()

public String getParentSkeletonDir()

public File getParentSkeletonDir(File parent)

public Resource getProfileDir()

public List<String> getRepositories()

public Iterable<Feature> getRequiredFeatures()

public List<String> getSkeletonExcludes()

public Resource getTemplate(String path)

public String getVersion()

public boolean handleCommand(ExecutionContext context)

public boolean hasCommand(ProjectContext context, String name)