KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > core > IIgnoreInfo


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.team.core;
12
13 /**
14  * An ignore info specifies both the pattern and the enabled state
15  * of a globally ignored pattern.
16  * <p>
17  * This interface is not intended to be implemented by clients.
18  *
19  * @since 2.0
20  */
21 public interface IIgnoreInfo {
22     /**
23      * Return the string specifying the pattern of this ignore. The string
24      * may include the wildcard characters '*' and '?'. If you wish to
25      * include either of these characters verbatim (i.e. you do not wish
26      * them to expand to wildcards), you must escape them with a backslash '\'.
27      * <p>
28      * If you are using string literals in Java to represent the patterns, don't
29      * forget escape characters are represented by "\\".
30      *
31      * @return the pattern represented by this ignore info
32      */
33     public String JavaDoc getPattern();
34     /**
35      * Return whether or not this ignore info is enabled. A disabled ignore
36      * info remains in the global ignore list, but no attempt is made to match
37      * with it to determine resource ignore state.
38      *
39      * @return whether the ignore info is enabled
40      */
41     public boolean getEnabled();
42 }
43
Popular Tags