Eclipse JDT
Release 3.1

org.eclipse.jdt.core
Interface IAccessRule


public interface IAccessRule

Describes an access rule to source and class files on a classpath entry. An access rule is composed of a file pattern and a kind (accessible, non accessible, or discouraged).

On a given classpath entry, the access rules are considered in the order given when the entry was created. When a source or class file matches an access rule's pattern, the access rule's kind define whether the file is considered accessible, non accessible, or its access is discouraged. If the source or class file doesn't match any accessible rule, it is considered accessible. A source or class file that is not accessible or discouraged can still be refered to but it is tagged as being not accessible - the Java builder will create a problem marker for example. The severity of the marker created from a non accessible rule is controled through the JavaCore.COMPILER_PB_FORBIDDEN_REFERENCE compiler option. The severity of the marker created from a discouraged rule is controled through the JavaCore.COMPILER_PB_DISCOURAGED_REFERENCE compiler option. Note this is different from inclusion and exclusion patterns on source classpath entries, where a source file that is excluded is not even compiled. Files patterns look like relative file paths with wildcards and are interpreted relative to each entry's path. File patterns are case-sensitive and they can contain '**', '*' or '?' wildcards (see IClasspathEntry.getExclusionPatterns() for the full description of their syntax and semantics). Note that file patterns must not include the file extension. com/xyz/tests/MyClass is a valid file pattern, whereas com/xyz/tests/MyClass.class is not valid.

For example, if one of the entry path is /Project/someLib.jar, there are no accessible rules, and there is one non accessible rule whith pattern com/xyz/tests/**, then class files like /Project/someLib.jar/com/xyz/Foo.class and /Project/someLib.jar/com/xyz/utils/Bar.class would be accessible, whereas /Project/someLib.jar/com/xyz/tests/T1.class and /Project/someLib.jar/com/xyz/tests/quick/T2.class would not be accessible.

Since:
3.1

Field Summary
static int K_ACCESSIBLE
          Constant indicating that files matching the rule's pattern are accessible.
static int K_DISCOURAGED
          Constant indicating that access to the files matching the rule's pattern is discouraged.
static int K_NON_ACCESSIBLE
          Constant indicating that files matching the rule's pattern are non accessible.
 
Method Summary
 int getKind()
          Returns the kind of this access rule (one of K_ACCESSIBLE, K_NON_ACCESSIBLE or K_DISCOURAGED).
 IPath getPattern()
          Returns the file pattern for this access rule.
 

Field Detail

K_ACCESSIBLE

public static final int K_ACCESSIBLE
Constant indicating that files matching the rule's pattern are accessible.

See Also:
Constant Field Values

K_NON_ACCESSIBLE

public static final int K_NON_ACCESSIBLE
Constant indicating that files matching the rule's pattern are non accessible.

See Also:
Constant Field Values

K_DISCOURAGED

public static final int K_DISCOURAGED
Constant indicating that access to the files matching the rule's pattern is discouraged.

See Also:
Constant Field Values
Method Detail

getPattern

public IPath getPattern()
Returns the file pattern for this access rule.

Returns:
the file pattern for this access rule

getKind

public int getKind()
Returns the kind of this access rule (one of K_ACCESSIBLE, K_NON_ACCESSIBLE or K_DISCOURAGED).

Returns:
the kind of this access rule

Eclipse JDT
Release 3.1

Copyright (c) IBM Corp. and others 2000, 2005. All Rights Reserved.