Package org.faktorips.devtools.abstraction

Interface AProject

All Superinterfaces:

AAbstraction, AContainer, AResource, java.lang.Comparable<AResource>, java.lang.Iterable<AResource>

All Known Implementing Classes:

EclipseProject, PlainJavaProject

public interface AProject
extends AContainer

A project is a special container wrapping resources and settings.

Nested Class Summary

Nested classes/interfaces inherited from interface org.faktorips.devtools.abstraction.AResource

AResource.AResourceTreeTraversalDepth, AResource.AResourceType

Field Summary

Fields inherited from interface org.faktorips.devtools.abstraction.AResource

COMPARING_BY_NAME

Method Summary

Modifier and Type	Method	Description
void	build(ABuildKind buildKind, org.eclipse.core.runtime.IProgressMonitor monitor)	Builds this project.
java.nio.charset.Charset	getDefaultCharset()	Returns the default character set used for files in this project.
AFile	getFile(java.lang.String name)	Returns the file with the given name inside this project.
AFolder	getFolder(java.lang.String name)	Returns the folder with the given name inside this project.
java.util.Set<AProject>	getReferencedProjects()	Returns all other projects this project references.
boolean	isIpsProject()	Returns whether this project is a Faktor-IPS project.

Methods inherited from interface org.faktorips.devtools.abstraction.AAbstraction

unwrap

Methods inherited from interface org.faktorips.devtools.abstraction.AContainer

findMember, getFile, getFolder, getMembers, iterator

Methods inherited from interface org.faktorips.devtools.abstraction.AResource

compareTo, copy, createMarker, delete, deleteMarkers, exists, findMarkers, getLocalTimeStamp, getLocation, getModificationStamp, getName, getParent, getProject, getProjectRelativePath, getType, getWorkspace, getWorkspaceRelativePath, isAccessible, isDerived, isSynchronized, move, refreshLocal, setDerived, touch

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

isIpsProject

boolean isIpsProject()

Returns whether this project is a Faktor-IPS project.

getFile

AFile getFile(java.lang.String name)

Returns the file with the given name inside this project. It may not exist.

Parameters:

name - a file name, will be resolved as a path relative to this project.

Returns:

the file identified by the name

getFolder

AFolder getFolder(java.lang.String name)

Returns the folder with the given name inside this project. It may not exist.

Parameters:

name - a folder name, will be resolved as a path relative to this project.

Returns:

the folder identified by the name

getReferencedProjects

java.util.Set<AProject> getReferencedProjects()

Returns all other projects this project references.

build

void build(ABuildKind buildKind,
           org.eclipse.core.runtime.IProgressMonitor monitor)

Builds this project. The buildKind parameter determines, whether an incremental or full build is done and whether output folders are cleaned beforehand.

Parameters:

buildKind - the kind of build to perform

monitor - a progress monitor that is notified about the build process. Individual file processing is reported to the monitor to allow fine-grained progress reporting. The monitor may be null when progress does not need to be reported.

getDefaultCharset

java.nio.charset.Charset getDefaultCharset()

Returns the default character set used for files in this project.