Package org.faktorips.devtools.abstraction.eclipse.internal

Class EclipseProject

java.lang.Object

org.faktorips.devtools.abstraction.AWrapper<org.eclipse.core.resources.IResource>

org.faktorips.devtools.abstraction.eclipse.internal.EclipseResource

org.faktorips.devtools.abstraction.eclipse.internal.EclipseContainer

org.faktorips.devtools.abstraction.eclipse.internal.EclipseProject

All Implemented Interfaces:

java.lang.Comparable<AResource>, java.lang.Iterable<AResource>, org.eclipse.core.runtime.IAdaptable, AAbstraction, AContainer, AProject, AResource

public class EclipseProject
extends EclipseContainer
implements AProject

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 kind, org.eclipse.core.runtime.IProgressMonitor monitor)	Builds this project.
void	delete(org.eclipse.core.runtime.IProgressMonitor monitor)	Deletes the resource from the file system.
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.
org.eclipse.core.resources.IProject	project()
org.eclipse.core.resources.IProject	unwrap()	Returns the platform-specific object corresponding to this abstraction.

Methods inherited from class org.faktorips.devtools.abstraction.eclipse.internal.EclipseContainer

findMember, getFile, getFolder, getMembers

Methods inherited from class org.faktorips.devtools.abstraction.eclipse.internal.EclipseResource

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

Methods inherited from class org.faktorips.devtools.abstraction.AWrapper

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, 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

unwrap

public org.eclipse.core.resources.IProject unwrap()

Description copied from interface: AAbstraction

Returns the platform-specific object corresponding to this abstraction. The generic type parameter is used to avoid casts when assigning to platform-specific objects. It is the obligation of the caller to make sure the right type is used, otherwise a ClassCastException will be thrown.

Sample usage:

 
 interface ACalendar extends AAbstraction[...]
 class LocalDateAsCalendarWrapper extends AWrapper<LocalDate>[...]
 [...]
 ACalendar calendar = Wrappers.of(LocalDate.now()).as(ACalendar.class);
 [...]
 LocalDate date = calendar.unwrap();
 
 

Specified by:

unwrap in interface AAbstraction

Overrides:

unwrap in class EclipseContainer

See Also:

Wrappers#unwrap(AAbstraction) for a way to unwrap potentially null abstractions.

project

public org.eclipse.core.resources.IProject project()

getFile

public AFile getFile(java.lang.String name)

Description copied from interface: AProject

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

Specified by:

getFile in interface AProject

Parameters:

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

Returns:

the file identified by the name

getFolder

public AFolder getFolder(java.lang.String name)

Description copied from interface: AProject

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

Specified by:

getFolder in interface AProject

Parameters:

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

Returns:

the folder identified by the name

getReferencedProjects

public java.util.Set<AProject> getReferencedProjects()

Description copied from interface: AProject

Returns all other projects this project references.

Specified by:

getReferencedProjects in interface AProject

delete

public void delete(org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: AResource

Deletes the resource from the file system.

Specified by:

delete in interface AResource

Overrides:

delete in class EclipseResource

Parameters:

monitor - a progress monitor that is notified about the deletion process. When deleting a directory, individual file deletions are reported to the monitor to allow fine-grained progress reporting. The monitor may be null when progress does not need to be reported.

isIpsProject

public boolean isIpsProject()

Description copied from interface: AProject

Returns whether this project is a Faktor-IPS project.

Specified by:

isIpsProject in interface AProject

build

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

Description copied from interface: AProject

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

Specified by:

build in interface AProject

Parameters:

kind - 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

public java.nio.charset.Charset getDefaultCharset()

Description copied from interface: AProject

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

Specified by:

getDefaultCharset in interface AProject