Resource.java example

Explorer
m2e-core-master
/*******************************************************************************
 * Copyright (c) 2008-2010 Sonatype, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *      Sonatype, Inc. - initial API and implementation
 *******************************************************************************/

package org.eclipse.m2e.model.edit.pom;

import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;


/**
 * <!-- begin-user-doc --> A representation of the model object ' <em><b>Resource</b></em>'. <!-- end-user-doc --> <!--
 * begin-model-doc --> 3.0.0+ This element describes all of the classpath resources associated with a project or unit
 * tests. <!-- end-model-doc -->
 * <p>
 * The following features are supported:
 * <ul>
 * <li>{@link org.eclipse.m2e.model.edit.pom.Resource#getTargetPath <em>Target Path</em>}</li>
 * <li>{@link org.eclipse.m2e.model.edit.pom.Resource#getFiltering <em>Filtering </em>}</li>
 * <li>{@link org.eclipse.m2e.model.edit.pom.Resource#getDirectory <em>Directory </em>}</li>
 * <li>{@link org.eclipse.m2e.model.edit.pom.Resource#getIncludes <em>Includes </em>}</li>
 * <li>{@link org.eclipse.m2e.model.edit.pom.Resource#getExcludes <em>Excludes </em>}</li>
 * </ul>
 * </p>
 * 
 * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource()
 * @model extendedMetaData="name='Resource' kind='elementOnly'"
 * @generated
 */
public interface Resource extends EObject {
  /**
   * Returns the value of the '<em><b>Target Path</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
   * <!-- begin-model-doc --> 3.0.0+ Describe the resource target path. For example, if you want that resource to appear
   * in a specific package (<code>org.apache.maven.messages</code>), you must specify this element with this
   * value: <code>org/apache/maven/messages</code>. This is not required if you simply put the resources in
   * that directory structure at the source, however. <!-- end-model-doc -->
   * 
   * @return the value of the '<em>Target Path</em>' attribute.
   * @see #setTargetPath(String)
   * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource_TargetPath()
   * @model dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData=
   *        "kind='element' name='targetPath' namespace='##targetNamespace'"
   * @generated
   */
  String getTargetPath();

  /**
   * Sets the value of the ' {@link org.eclipse.m2e.model.edit.pom.Resource#getTargetPath <em>Target Path</em>}'
   * attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
   * 
   * @param value the new value of the '<em>Target Path</em>' attribute.
   * @see #getTargetPath()
   * @generated
   */
  void setTargetPath(String value);

  /**
   * Returns the value of the '<em><b>Filtering</b></em>' attribute. The default value is <code>"false"</code>. <!--
   * begin-user-doc --> <!-- end-user-doc --> <!-- begin-model-doc --> 3.0.0+ Whether resources are filtered to replace
   * tokens with parameterised values or not. The values are taken from the <code>properties</code> element
   * and from the properties in the files listed in the <code>filters</code> element. <!-- end-model-doc -->
   * 
   * @return the value of the '<em>Filtering</em>' attribute.
   * @see #isSetFiltering()
   * @see #unsetFiltering()
   * @see #setFiltering(String)
   * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource_Filtering()
   * @model default="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData=
   *        "kind='element' name='filtering' namespace='##targetNamespace'"
   * @generated
   */
  String getFiltering();

  /**
   * Sets the value of the ' {@link org.eclipse.m2e.model.edit.pom.Resource#getFiltering <em>Filtering</em>}' attribute.
   * <!-- begin-user-doc --> <!-- end-user-doc -->
   * 
   * @param value the new value of the '<em>Filtering</em>' attribute.
   * @see #isSetFiltering()
   * @see #unsetFiltering()
   * @see #getFiltering()
   * @generated
   */
  void setFiltering(String value);

  /**
   * Unsets the value of the ' {@link org.eclipse.m2e.model.edit.pom.Resource#getFiltering <em>Filtering</em>}'
   * attribute. <!-- begin-user-doc --> <!-- end-user-doc -->
   * 
   * @see #isSetFiltering()
   * @see #getFiltering()
   * @see #setFiltering(String)
   * @generated
   */
  void unsetFiltering();

  /**
   * Returns whether the value of the ' {@link org.eclipse.m2e.model.edit.pom.Resource#getFiltering <em>Filtering</em>}'
   * attribute is set. <!-- begin-user-doc --> <!-- end-user-doc -->
   * 
   * @return whether the value of the '<em>Filtering</em>' attribute is set.
   * @see #unsetFiltering()
   * @see #getFiltering()
   * @see #setFiltering(String)
   * @generated
   */
  boolean isSetFiltering();

  /**
   * Returns the value of the '<em><b>Directory</b></em>' attribute. <!-- begin-user-doc --> <!-- end-user-doc --> <!--
   * begin-model-doc --> 3.0.0+ Describe the directory where the resources are stored. The path is relative to the POM.
   * <!-- end-model-doc -->
   * 
   * @return the value of the '<em>Directory</em>' attribute.
   * @see #setDirectory(String)
   * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource_Directory()
   * @model dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData=
   *        "kind='element' name='directory' namespace='##targetNamespace'"
   * @generated
   */
  String getDirectory();

  /**
   * Sets the value of the ' {@link org.eclipse.m2e.model.edit.pom.Resource#getDirectory <em>Directory</em>}' attribute.
   * <!-- begin-user-doc --> <!-- end-user-doc -->
   * 
   * @param value the new value of the '<em>Directory</em>' attribute.
   * @see #getDirectory()
   * @generated
   */
  void setDirectory(String value);

  /**
   * Returns the value of the '<em><b>Includes</b></em>' attribute list. The list contents are of type
   * {@link java.lang.String}. <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Includes</em>' attribute list isn't clear, there really should be more of a description
   * here...
   * </p>
   * <!-- end-user-doc -->
   * 
   * @return the value of the '<em>Includes</em>' attribute list.
   * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource_Includes()
   * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
   * @generated
   */
  EList<String> getIncludes();

  /**
   * Returns the value of the '<em><b>Excludes</b></em>' attribute list. The list contents are of type
   * {@link java.lang.String}. <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Excludes</em>' attribute list isn't clear, there really should be more of a description
   * here...
   * </p>
   * <!-- end-user-doc -->
   * 
   * @return the value of the '<em>Excludes</em>' attribute list.
   * @see org.eclipse.m2e.model.edit.pom.PomPackage#getResource_Excludes()
   * @model unique="false" dataType="org.eclipse.emf.ecore.xml.type.String"
   * @generated
   */
  EList<String> getExcludes();

} // Resource