plugins/org.eclipse.oomph.projectconfig/src/org/eclipse/oomph/projectconfig/PreferenceFilter.java

/*
 * Copyright (c) 2014, 2015 Eike Stepper (Berlin, Germany) and others.
 * 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:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.oomph.projectconfig;

import org.eclipse.oomph.base.ModelElement;
import org.eclipse.oomph.preferences.PreferenceNode;
import org.eclipse.oomph.preferences.Property;

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

import java.util.regex.Pattern;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Preference Filter</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * </p>
 * <ul>
 *   <li>{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getPreferenceNode <em>Preference Node</em>}</li>
 *   <li>{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getPreferenceProfile <em>Preference Profile</em>}</li>
 *   <li>{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getInclusions <em>Inclusions</em>}</li>
 *   <li>{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getExclusions <em>Exclusions</em>}</li>
 *   <li>{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getProperties <em>Properties</em>}</li>
 * </ul>
 *
 * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter()
 * @model
 * @generated
 */
public interface PreferenceFilter extends ModelElement
{
  /**
   * Returns the value of the '<em><b>Preference Node</b></em>' reference.
   * <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Preference Node</em>' reference isn't clear,
   * there really should be more of a description here...
   * </p>
   * <!-- end-user-doc -->
   * @return the value of the '<em>Preference Node</em>' reference.
   * @see #setPreferenceNode(PreferenceNode)
   * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter_PreferenceNode()
   * @model required="true"
   * @generated
   */
  PreferenceNode getPreferenceNode();

  /**
   * Sets the value of the '{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getPreferenceNode <em>Preference Node</em>}' reference.
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @param value the new value of the '<em>Preference Node</em>' reference.
   * @see #getPreferenceNode()
   * @generated
   */
  void setPreferenceNode(PreferenceNode value);

  /**
   * Returns the value of the '<em><b>Preference Profile</b></em>' container reference.
   * It is bidirectional and its opposite is '{@link org.eclipse.oomph.projectconfig.PreferenceProfile#getPreferenceFilters <em>Preference Filters</em>}'.
   * <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Preference Profile</em>' container reference isn't clear,
   * there really should be more of a description here...
   * </p>
   * <!-- end-user-doc -->
   * @return the value of the '<em>Preference Profile</em>' container reference.
   * @see #setPreferenceProfile(PreferenceProfile)
   * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter_PreferenceProfile()
   * @see org.eclipse.oomph.projectconfig.PreferenceProfile#getPreferenceFilters
   * @model opposite="preferenceFilters" required="true" transient="false"
   * @generated
   */
  PreferenceProfile getPreferenceProfile();

  /**
   * Sets the value of the '{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getPreferenceProfile <em>Preference Profile</em>}' container reference.
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @param value the new value of the '<em>Preference Profile</em>' container reference.
   * @see #getPreferenceProfile()
   * @generated
   */
  void setPreferenceProfile(PreferenceProfile value);

  /**
   * Returns the value of the '<em><b>Inclusions</b></em>' attribute.
   * The default value is <code>".*"</code>.
   * <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Inclusions</em>' attribute isn't clear,
   * there really should be more of a description here...
   * </p>
   * <!-- end-user-doc -->
   * @return the value of the '<em>Inclusions</em>' attribute.
   * @see #setInclusions(Pattern)
   * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter_Inclusions()
   * @model default=".*" dataType="org.eclipse.oomph.projectconfig.Pattern" required="true"
   * @generated
   */
  Pattern getInclusions();

  /**
   * Sets the value of the '{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getInclusions <em>Inclusions</em>}' attribute.
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @param value the new value of the '<em>Inclusions</em>' attribute.
   * @see #getInclusions()
   * @generated
   */
  void setInclusions(Pattern value);

  /**
   * Returns the value of the '<em><b>Exclusions</b></em>' attribute.
   * The default value is <code>""</code>.
   * <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Exclusions</em>' attribute isn't clear,
   * there really should be more of a description here...
   * </p>
   * <!-- end-user-doc -->
   * @return the value of the '<em>Exclusions</em>' attribute.
   * @see #setExclusions(Pattern)
   * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter_Exclusions()
   * @model default="" dataType="org.eclipse.oomph.projectconfig.Pattern" required="true"
   * @generated
   */
  Pattern getExclusions();

  /**
   * Sets the value of the '{@link org.eclipse.oomph.projectconfig.PreferenceFilter#getExclusions <em>Exclusions</em>}' attribute.
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @param value the new value of the '<em>Exclusions</em>' attribute.
   * @see #getExclusions()
   * @generated
   */
  void setExclusions(Pattern value);

  /**
   * Returns the value of the '<em><b>Properties</b></em>' reference list.
   * The list contents are of type {@link org.eclipse.oomph.preferences.Property}.
   * <!-- begin-user-doc -->
   * <p>
   * If the meaning of the '<em>Properties</em>' reference list isn't clear,
   * there really should be more of a description here...
   * </p>
   * <!-- end-user-doc -->
   * @return the value of the '<em>Properties</em>' reference list.
   * @see org.eclipse.oomph.projectconfig.ProjectConfigPackage#getPreferenceFilter_Properties()
   * @model transient="true" changeable="false" volatile="true" derived="true"
   * @generated
   */
  EList<Property> getProperties();

  /**
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @model
   * @generated
   */
  boolean matches(String value);

  /**
   * <!-- begin-user-doc -->
   * <!-- end-user-doc -->
   * @model
   * @generated
   */
  Property getProperty(String name);

} // PreferenceFilter