org.jboss.forge.addon.projects

Interface Project

All Superinterfaces:

Faceted<ProjectFacet>

All Known Implementing Classes:

AbstractProject

public interface Project
extends Faceted<ProjectFacet>

Describes a set of Resource instances that represent a unit of work.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(Object key) Get a value from this project's internal attributes.
Resource<?>	getRoot() Get the Resource representing the root of this Project.
default DirectoryResource	getRootDirectory() Deprecated.
default Optional<Stack>	getStack() A project may have a stack associated with it
void	removeAttribute(Object key) Remove a value from this project's internal attributes.
void	setAttribute(Object key, Object value) Set a value in this project's internal attributes.

Methods inherited from interface org.jboss.forge.addon.facets.Faceted

getFacet, getFacetAsOptional, getFacets, getFacets, hasAllFacets, hasAllFacets, hasFacet, supports

Method Detail

getAttribute

Object getAttribute(Object key)

Get a value from this project's internal attributes. If the value is not set, return null instead.

setAttribute

void setAttribute(Object key,
                  Object value)

Set a value in this project's internal attributes.

removeAttribute

void removeAttribute(Object key)

Remove a value from this project's internal attributes.

getRootDirectory

@Deprecated
default DirectoryResource getRootDirectory()

Deprecated.

Get the DirectoryResource representing the root directory of this Project.

getRoot

Resource<?> getRoot()

Get the Resource representing the root of this Project.

getStack

default Optional<Stack> getStack()

A project may have a stack associated with it

Returns:

an Optional containing the associated stack