blob: a58df5e4a04aef61d1975637e3bb258c88e791e5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ProjectFactory (Oomph Utilities Documentation)</title>
<meta name="date" content="">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProjectFactory (Oomph Utilities Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProjectFactory.html">Use</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/oomph/resources/MavenProjectFactory.html" title="interface in org.eclipse.oomph.resources"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/eclipse/oomph/resources/ProjectHandler.html" title="interface in org.eclipse.oomph.resources"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/oomph/resources/ProjectFactory.html" target="_top">Frames</a></li>
<li><a href="ProjectFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.oomph.resources</div>
<h2 title="Interface ProjectFactory" class="title">Interface ProjectFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a>, <a href="../../../../org/eclipse/oomph/base/ModelElement.html" title="interface in org.eclipse.oomph.base">ModelElement</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true" title="class or interface in org.eclipse.emf.common.notify">Notifier</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/eclipse/oomph/resources/EclipseProjectFactory.html" title="interface in org.eclipse.oomph.resources">EclipseProjectFactory</a>, <a href="../../../../org/eclipse/oomph/resources/MavenProjectFactory.html" title="interface in org.eclipse.oomph.resources">MavenProjectFactory</a>, <a href="../../../../org/eclipse/oomph/resources/XMLProjectFactory.html" title="interface in org.eclipse.oomph.resources">XMLProjectFactory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/eclipse/oomph/resources/impl/EclipseProjectFactoryImpl.html" title="class in org.eclipse.oomph.resources.impl">EclipseProjectFactoryImpl</a>, <a href="../../../../org/eclipse/oomph/resources/impl/MavenProjectFactoryImpl.html" title="class in org.eclipse.oomph.resources.impl">MavenProjectFactoryImpl</a>, <a href="../../../../org/eclipse/oomph/resources/impl/ProjectFactoryImpl.html" title="class in org.eclipse.oomph.resources.impl">ProjectFactoryImpl</a>, <a href="../../../../org/eclipse/oomph/resources/impl/XMLProjectFactoryImpl.html" title="class in org.eclipse.oomph.resources.impl">XMLProjectFactoryImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ProjectFactory</span>
extends <a href="../../../../org/eclipse/oomph/base/ModelElement.html" title="interface in org.eclipse.oomph.base">ModelElement</a></pre>
<div class="block"><!-- begin-user-doc -->
A representation of the model object '<em><b>Project Factory</b></em>'.
<!-- end-user-doc -->
<p>
The following features are supported:
<ul>
<li><a href="../../../../org/eclipse/oomph/resources/ProjectFactory.html#getExcludedPaths()"><code><em>Excluded Paths</em></code></a></li>
</ul>
</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/eclipse/oomph/resources/ResourcesPackage.html#getProjectFactory()"><code>ResourcesPackage.getProjectFactory()</code></a></dd><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>abstract="true"</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://help.eclipse.org/topic//org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/resources/IProject.html?is-external=true" title="class or interface in org.eclipse.core.resources">IProject</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/oomph/resources/ProjectFactory.html#createProject(org.eclipse.oomph.resources.backend.BackendContainer,%20org.eclipse.oomph.resources.backend.BackendContainer,%20org.eclipse.core.runtime.IProgressMonitor)">createProject</a></strong>(<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;rootContainer,
<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;backendContainer,
<a href="http://help.eclipse.org/topic//org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/runtime/IProgressMonitor.html?is-external=true" title="class or interface in org.eclipse.core.runtime">IProgressMonitor</a>&nbsp;monitor)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/EList.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">EList</a>&lt;<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/oomph/resources/ProjectFactory.html#getExcludedPaths()">getExcludedPaths</a></strong>()</code>
<div class="block">Returns the value of the '<em><b>Excluded Paths</b></em>' attribute list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/eclipse/oomph/resources/ProjectFactory.html#isExcludedPath(org.eclipse.oomph.resources.backend.BackendContainer,%20org.eclipse.oomph.resources.backend.BackendContainer)">isExcludedPath</a></strong>(<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;rootContainer,
<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;backendContainer)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.oomph.base.ModelElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.oomph.base.<a href="../../../../org/eclipse/oomph/base/ModelElement.html" title="interface in org.eclipse.oomph.base">ModelElement</a></h3>
<code><a href="../../../../org/eclipse/oomph/base/ModelElement.html#getAnnotation(java.lang.String)">getAnnotation</a>, <a href="../../../../org/eclipse/oomph/base/ModelElement.html#getAnnotations()">getAnnotations</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.emf.ecore.EObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.ecore.<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true" title="class or interface in org.eclipse.emf.ecore">EObject</a></h3>
<code><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eAllContents()" title="class or interface in org.eclipse.emf.ecore">eAllContents</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eClass()" title="class or interface in org.eclipse.emf.ecore">eClass</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainer()" title="class or interface in org.eclipse.emf.ecore">eContainer</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainingFeature()" title="class or interface in org.eclipse.emf.ecore">eContainingFeature</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContainmentFeature()" title="class or interface in org.eclipse.emf.ecore">eContainmentFeature</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eContents()" title="class or interface in org.eclipse.emf.ecore">eContents</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eCrossReferences()" title="class or interface in org.eclipse.emf.ecore">eCrossReferences</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eGet(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eGet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eGet(org.eclipse.emf.ecore.EStructuralFeature,%20boolean)" title="class or interface in org.eclipse.emf.ecore">eGet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eInvoke(org.eclipse.emf.ecore.EOperation,%20org.eclipse.emf.common.util.EList)" title="class or interface in org.eclipse.emf.ecore">eInvoke</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eIsProxy()" title="class or interface in org.eclipse.emf.ecore">eIsProxy</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eIsSet(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eIsSet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eResource()" title="class or interface in org.eclipse.emf.ecore">eResource</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eSet(org.eclipse.emf.ecore.EStructuralFeature,%20java.lang.Object)" title="class or interface in org.eclipse.emf.ecore">eSet</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/ecore/EObject.html?is-external=true#eUnset(org.eclipse.emf.ecore.EStructuralFeature)" title="class or interface in org.eclipse.emf.ecore">eUnset</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.emf.common.notify.Notifier">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.common.notify.<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true" title="class or interface in org.eclipse.emf.common.notify">Notifier</a></h3>
<code><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eAdapters()" title="class or interface in org.eclipse.emf.common.notify">eAdapters</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eDeliver()" title="class or interface in org.eclipse.emf.common.notify">eDeliver</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eNotify(org.eclipse.emf.common.notify.Notification)" title="class or interface in org.eclipse.emf.common.notify">eNotify</a>, <a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/notify/Notifier.html?is-external=true#eSetDeliver(boolean)" title="class or interface in org.eclipse.emf.common.notify">eSetDeliver</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getExcludedPaths()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExcludedPaths</h4>
<pre><a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/EList.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">EList</a>&lt;<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getExcludedPaths()</pre>
<div class="block">Returns the value of the '<em><b>Excluded Paths</b></em>' attribute list.
The list contents are of type <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>.
<!-- begin-user-doc -->
<p>
If the meaning of the '<em>Excluded Paths</em>' attribute list isn't clear,
there really should be more of a description here...
</p>
<!-- end-user-doc --></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value of the '<em>Excluded Paths</em>' attribute list.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/eclipse/oomph/resources/ResourcesPackage.html#getProjectFactory_ExcludedPaths()"><code>ResourcesPackage.getProjectFactory_ExcludedPaths()</code></a></dd><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>extendedMetaData="name='excludedPath'"</dd></dl>
</li>
</ul>
<a name="createProject(org.eclipse.oomph.resources.backend.BackendContainer, org.eclipse.oomph.resources.backend.BackendContainer, org.eclipse.core.runtime.IProgressMonitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createProject</h4>
<pre><a href="http://help.eclipse.org/topic//org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/resources/IProject.html?is-external=true" title="class or interface in org.eclipse.core.resources">IProject</a>&nbsp;createProject(<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;rootContainer,
<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;backendContainer,
<a href="http://help.eclipse.org/topic//org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/runtime/IProgressMonitor.html?is-external=true" title="class or interface in org.eclipse.core.runtime">IProgressMonitor</a>&nbsp;monitor)</pre>
<div class="block"><!-- begin-user-doc -->
<!-- end-user-doc --></div>
<dl><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>dataType="org.eclipse.oomph.predicates.Project" rootContainerDataType="org.eclipse.oomph.resources.BackendContainer" backendContainerDataType="org.eclipse.oomph.resources.BackendContainer" monitorDataType="org.eclipse.oomph.resources.ProgressMonitor"</dd></dl>
</li>
</ul>
<a name="isExcludedPath(org.eclipse.oomph.resources.backend.BackendContainer, org.eclipse.oomph.resources.backend.BackendContainer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isExcludedPath</h4>
<pre>boolean&nbsp;isExcludedPath(<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;rootContainer,
<a href="../../../../org/eclipse/oomph/resources/backend/BackendContainer.html" title="class in org.eclipse.oomph.resources.backend">BackendContainer</a>&nbsp;backendContainer)</pre>
<div class="block"><!-- begin-user-doc -->
<!-- end-user-doc --></div>
<dl><dt><span class="strong">Generated</span></dt>
<dd></dd>
<dt><span class="strong">Model</span></dt>
<dd>rootContainerDataType="org.eclipse.oomph.resources.BackendContainer" backendContainerDataType="org.eclipse.oomph.resources.BackendContainer"</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProjectFactory.html">Use</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/oomph/resources/MavenProjectFactory.html" title="interface in org.eclipse.oomph.resources"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/eclipse/oomph/resources/ProjectHandler.html" title="interface in org.eclipse.oomph.resources"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/oomph/resources/ProjectFactory.html" target="_top">Frames</a></li>
<li><a href="ProjectFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i class="copyright">Copyright (c) 2014 Eike Stepper (Loehne, Germany) and others.<br>All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v20.html</i></small></p>
</body>
</html>