docs/org.eclipse.wst.jsdt.doc/html/api_reference/org/eclipse/wst/jsdt/core/IAccessRule.html - gerrit/jsdt/webtools.jsdt.core - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--NewPage-->
 <HTML>
 <HEAD>
 <!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:15:47 CDT 2008 -->
 <TITLE>
 IAccessRule
 </TITLE>

 <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IAccessRule interface">

 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">

 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     parent.document.title="IAccessRule";
 }
 </SCRIPT>
 <NOSCRIPT>
 </NOSCRIPT>

 </HEAD>

 <BODY BGCOLOR="white" onload="windowTitle();">


 <!-- ========= START OF TOP NAVBAR ======= -->
 <A NAME="navbar_top"><!-- --></A>
 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_top_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IAccessRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/Flags.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IAccessRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="IAccessRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
 <!-- ========= END OF TOP NAVBAR ========= -->

 <HR>
 <!-- ======== START OF CLASS DATA ======== -->
 <H2>
 <FONT SIZE="-1">
 org.eclipse.wst.jsdt.core</FONT>
 <BR>
 Interface IAccessRule</H2>
 <HR>
 <DL>
 <DT><PRE>public interface <B>IAccessRule</B></DL>
 </PRE>

 <P>
 Describes an access rule to source and class files on a includepath entry.
  An access rule is composed of a file pattern and a kind (accessible,
  non accessible, or discouraged).
  <p>
  On a given includepath entry, the access rules are considered in the order given
  when the entry was created. When a source 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
  file doesn't match any accessible rule, it is considered accessible. A source
  file that is not accessible or discouraged can still be refered to but it is tagged as being not
  accessible - the JavaScript validator will create a problem marker for example.
  The severity of the marker created from a non accessible rule is controled through
  the <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#COMPILER_PB_FORBIDDEN_REFERENCE"><CODE>JavaScriptCore.COMPILER_PB_FORBIDDEN_REFERENCE</CODE></A> compiler option.
  The severity of the marker created from a discouraged rule is controled through
  the <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#COMPILER_PB_DISCOURAGED_REFERENCE"><CODE>JavaScriptCore.COMPILER_PB_DISCOURAGED_REFERENCE</CODE></A> compiler option.
  Note this is different from inclusion and exclusion patterns on source includepath entries,
  where a source file that is excluded is not even validated.
  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
  <A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getExclusionPatterns()"><CODE>IIncludePathEntry.getExclusionPatterns()</CODE></A> for the full description
  of their syntax and semantics).
  Note that file patterns must not include the file extension.
  <code>com/xyz/tests/MyClass</code> is a valid file pattern, whereas
  <code>com/xyz/tests/MyClass.class</code> is not valid.
  </p>


  Provisional API: This class/interface is part of an interim API that is still under development and expected to
  change significantly before reaching stability. It is being made available at this early stage to solicit feedback
  from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
  (repeatedly) as the API evolves.
 <P>

 <P>
 <HR>

 <P>
 <!-- =========== FIELD SUMMARY =========== -->

 <A NAME="field_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Field Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#IGNORE_IF_BETTER">IGNORE_IF_BETTER</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag indicating that whether a type matching this rule should be ignored iff a type with
  the same qualified name can be found on a later includepath entry with a better
  accessibility.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE">K_ACCESSIBLE</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant indicating that files matching the rule's pattern are accessible.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED">K_DISCOURAGED</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant indicating that access to the files matching the rule's pattern is discouraged.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>static&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE">K_NON_ACCESSIBLE</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant indicating that files matching the rule's pattern are non accessible.</TD>
 </TR>
 </TABLE>
 &nbsp;
 <!-- ========== METHOD SUMMARY =========== -->

 <A NAME="method_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Method Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;int</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#getKind()">getKind</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the kind of this access rule (one of <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE"><CODE>K_ACCESSIBLE</CODE></A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE"><CODE>K_NON_ACCESSIBLE</CODE></A>
  or <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED"><CODE>K_DISCOURAGED</CODE></A>).</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;IPath</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#getPattern()">getPattern</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the file pattern for this access rule.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;boolean</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#ignoreIfBetter()">ignoreIfBetter</A></B>()</CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether a type matching this rule should be ignored iff a type with
  the same qualified name can be found on a later includepath entry with a better
  accessibility.</TD>
 </TR>
 </TABLE>
 &nbsp;
 <P>

 <!-- ============ FIELD DETAIL =========== -->

 <A NAME="field_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Field Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="K_ACCESSIBLE"><!-- --></A><H3>
 K_ACCESSIBLE</H3>
 <PRE>
 static final int <B>K_ACCESSIBLE</B></PRE>
 <DL>
 <DD>Constant indicating that files matching the rule's pattern are accessible.
 <P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_ACCESSIBLE">Constant Field Values</A></DL>
 </DL>
 <HR>

 <A NAME="K_NON_ACCESSIBLE"><!-- --></A><H3>
 K_NON_ACCESSIBLE</H3>
 <PRE>
 static final int <B>K_NON_ACCESSIBLE</B></PRE>
 <DL>
 <DD>Constant indicating that files matching the rule's pattern are non accessible.
 <P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_NON_ACCESSIBLE">Constant Field Values</A></DL>
 </DL>
 <HR>

 <A NAME="K_DISCOURAGED"><!-- --></A><H3>
 K_DISCOURAGED</H3>
 <PRE>
 static final int <B>K_DISCOURAGED</B></PRE>
 <DL>
 <DD>Constant indicating that access to the files matching the rule's pattern is discouraged.
 <P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_DISCOURAGED">Constant Field Values</A></DL>
 </DL>
 <HR>

 <A NAME="IGNORE_IF_BETTER"><!-- --></A><H3>
 IGNORE_IF_BETTER</H3>
 <PRE>
 static final int <B>IGNORE_IF_BETTER</B></PRE>
 <DL>
 <DD><p>Flag indicating that whether a type matching this rule should be ignored iff a type with
  the same qualified name can be found on a later includepath entry with a better
  accessibility.</p>
  <p>E.g. if a type p.X matches a rule K_NON_ACCESSIBLE | IGNORE_IF_BETTER
  on a library entry 'lib1' and another type p.X also matches a rule
  K_DISCOURAGED on library entry 'lib2' ('lib2' being after 'lib1' on the
  includepath), then p.X from 'lib2' will be used and reported as
  discouraged.</p>
 <P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.IGNORE_IF_BETTER">Constant Field Values</A></DL>
 </DL>

 <!-- ============ METHOD DETAIL ========== -->

 <A NAME="method_detail"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 <B>Method Detail</B></FONT></TH>
 </TR>
 </TABLE>

 <A NAME="getPattern()"><!-- --></A><H3>
 getPattern</H3>
 <PRE>
 IPath <B>getPattern</B>()</PRE>
 <DL>
 <DD>Returns the file pattern for this access rule.
 <P>
 <DD><DL>

 <DT><B>Returns:</B><DD>the file pattern for this access rule</DL>
 </DD>
 </DL>
 <HR>

 <A NAME="getKind()"><!-- --></A><H3>
 getKind</H3>
 <PRE>
 int <B>getKind</B>()</PRE>
 <DL>
 <DD>Returns the kind of this access rule (one of <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE"><CODE>K_ACCESSIBLE</CODE></A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE"><CODE>K_NON_ACCESSIBLE</CODE></A>
  or <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED"><CODE>K_DISCOURAGED</CODE></A>).
 <P>
 <DD><DL>

 <DT><B>Returns:</B><DD>the kind of this access rule</DL>
 </DD>
 </DL>
 <HR>

 <A NAME="ignoreIfBetter()"><!-- --></A><H3>
 ignoreIfBetter</H3>
 <PRE>
 boolean <B>ignoreIfBetter</B>()</PRE>
 <DL>
 <DD><p>Returns whether a type matching this rule should be ignored iff a type with
  the same qualified name can be found on a later includepath entry with a better
  accessibility.</p>
  <p>E.g. if a type p.X matches a rule K_NON_ACCESSIBLE | IGNORE_IF_BETTER
  on a library entry 'lib1' and another type p.X also matches a rule
  K_DISCOURAGED on library entry 'lib2' ('lib2' being after 'lib1' on the
  includepath), then p.X from 'lib2' will be used and reported as
  discouraged.</p>
 <P>
 <DD><DL>

 <DT><B>Returns:</B><DD>whether a type matching this rule should be ignored iff a type
               with the same qualified name can be found on a later includepath
               entry with a better accessibility</DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>


 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <A NAME="navbar_bottom"><!-- --></A>
 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IAccessRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 </EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/Flags.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IAccessRule.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="IAccessRule.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_bottom"></A>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->

 <HR>

 </BODY>
 </HTML>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:15:47 CDT 2008 -->
	<TITLE>
	IAccessRule
	</TITLE>

	<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IAccessRule interface">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	parent.document.title="IAccessRule";
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IAccessRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../../org/eclipse/wst/jsdt/core/Flags.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>
	<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IAccessRule.html" target="_top"><B>FRAMES</B></A>
	<A HREF="IAccessRule.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| CONSTR \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#field_detail">FIELD</A> \| CONSTR \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	org.eclipse.wst.jsdt.core</FONT>
	<BR>
	Interface IAccessRule</H2>
	<HR>
	<DL>
	<DT><PRE>public interface <B>IAccessRule</B></DL>
	</PRE>

	<P>
	Describes an access rule to source and class files on a includepath entry.
	An access rule is composed of a file pattern and a kind (accessible,
	non accessible, or discouraged).
	<p>
	On a given includepath entry, the access rules are considered in the order given
	when the entry was created. When a source 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
	file doesn't match any accessible rule, it is considered accessible. A source
	file that is not accessible or discouraged can still be refered to but it is tagged as being not
	accessible - the JavaScript validator will create a problem marker for example.
	The severity of the marker created from a non accessible rule is controled through
	the <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#COMPILER_PB_FORBIDDEN_REFERENCE"><CODE>JavaScriptCore.COMPILER_PB_FORBIDDEN_REFERENCE</CODE></A> compiler option.
	The severity of the marker created from a discouraged rule is controled through
	the <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptCore.html#COMPILER_PB_DISCOURAGED_REFERENCE"><CODE>JavaScriptCore.COMPILER_PB_DISCOURAGED_REFERENCE</CODE></A> compiler option.
	Note this is different from inclusion and exclusion patterns on source includepath entries,
	where a source file that is excluded is not even validated.
	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
	<A HREF="../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#getExclusionPatterns()"><CODE>IIncludePathEntry.getExclusionPatterns()</CODE></A> for the full description
	of their syntax and semantics).
	Note that file patterns must not include the file extension.
	<code>com/xyz/tests/MyClass</code> is a valid file pattern, whereas
	<code>com/xyz/tests/MyClass.class</code> is not valid.
	</p>


	Provisional API: This class/interface is part of an interim API that is still under development and expected to
	change significantly before reaching stability. It is being made available at this early stage to solicit feedback
	from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
	(repeatedly) as the API evolves.
	<P>

	<P>
	<HR>

	<P>
	<!-- =========== FIELD SUMMARY =========== -->

	<A NAME="field_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Field Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#IGNORE_IF_BETTER">IGNORE_IF_BETTER</A></B></CODE>

	<BR>
	Flag indicating that whether a type matching this rule should be ignored iff a type with
	the same qualified name can be found on a later includepath entry with a better
	accessibility.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE">K_ACCESSIBLE</A></B></CODE>

	<BR>
	Constant indicating that files matching the rule's pattern are accessible.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED">K_DISCOURAGED</A></B></CODE>

	<BR>
	Constant indicating that access to the files matching the rule's pattern is discouraged.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE>static int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE">K_NON_ACCESSIBLE</A></B></CODE>

	<BR>
	Constant indicating that files matching the rule's pattern are non accessible.</TD>
	</TR>
	</TABLE>

	<!-- ========== METHOD SUMMARY =========== -->

	<A NAME="method_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Method Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> int</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#getKind()">getKind</A></B>()</CODE>

	<BR>
	Returns the kind of this access rule (one of <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE"><CODE>K_ACCESSIBLE</CODE></A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE"><CODE>K_NON_ACCESSIBLE</CODE></A>
	or <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED"><CODE>K_DISCOURAGED</CODE></A>).</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> IPath</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#getPattern()">getPattern</A></B>()</CODE>

	<BR>
	Returns the file pattern for this access rule.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> boolean</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#ignoreIfBetter()">ignoreIfBetter</A></B>()</CODE>

	<BR>
	Returns whether a type matching this rule should be ignored iff a type with
	the same qualified name can be found on a later includepath entry with a better
	accessibility.</TD>
	</TR>
	</TABLE>

	<P>

	<!-- ============ FIELD DETAIL =========== -->

	<A NAME="field_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Field Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="K_ACCESSIBLE"><!-- --></A><H3>
	K_ACCESSIBLE</H3>
	<PRE>
	static final int <B>K_ACCESSIBLE</B></PRE>
	<DL>
	<DD>Constant indicating that files matching the rule's pattern are accessible.
	<P>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_ACCESSIBLE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="K_NON_ACCESSIBLE"><!-- --></A><H3>
	K_NON_ACCESSIBLE</H3>
	<PRE>
	static final int <B>K_NON_ACCESSIBLE</B></PRE>
	<DL>
	<DD>Constant indicating that files matching the rule's pattern are non accessible.
	<P>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_NON_ACCESSIBLE">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="K_DISCOURAGED"><!-- --></A><H3>
	K_DISCOURAGED</H3>
	<PRE>
	static final int <B>K_DISCOURAGED</B></PRE>
	<DL>
	<DD>Constant indicating that access to the files matching the rule's pattern is discouraged.
	<P>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.K_DISCOURAGED">Constant Field Values</A></DL>
	</DL>
	<HR>

	<A NAME="IGNORE_IF_BETTER"><!-- --></A><H3>
	IGNORE_IF_BETTER</H3>
	<PRE>
	static final int <B>IGNORE_IF_BETTER</B></PRE>
	<DL>
	<DD><p>Flag indicating that whether a type matching this rule should be ignored iff a type with
	the same qualified name can be found on a later includepath entry with a better
	accessibility.</p>
	<p>E.g. if a type p.X matches a rule K_NON_ACCESSIBLE \| IGNORE_IF_BETTER
	on a library entry 'lib1' and another type p.X also matches a rule
	K_DISCOURAGED on library entry 'lib2' ('lib2' being after 'lib1' on the
	includepath), then p.X from 'lib2' will be used and reported as
	discouraged.</p>
	<P>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.eclipse.wst.jsdt.core.IAccessRule.IGNORE_IF_BETTER">Constant Field Values</A></DL>
	</DL>

	<!-- ============ METHOD DETAIL ========== -->

	<A NAME="method_detail"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
	<B>Method Detail</B></FONT></TH>
	</TR>
	</TABLE>

	<A NAME="getPattern()"><!-- --></A><H3>
	getPattern</H3>
	<PRE>
	IPath <B>getPattern</B>()</PRE>
	<DL>
	<DD>Returns the file pattern for this access rule.
	<P>
	<DD><DL>

	<DT><B>Returns:</B><DD>the file pattern for this access rule</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="getKind()"><!-- --></A><H3>
	getKind</H3>
	<PRE>
	int <B>getKind</B>()</PRE>
	<DL>
	<DD>Returns the kind of this access rule (one of <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_ACCESSIBLE"><CODE>K_ACCESSIBLE</CODE></A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_NON_ACCESSIBLE"><CODE>K_NON_ACCESSIBLE</CODE></A>
	or <A HREF="../../../../../org/eclipse/wst/jsdt/core/IAccessRule.html#K_DISCOURAGED"><CODE>K_DISCOURAGED</CODE></A>).
	<P>
	<DD><DL>

	<DT><B>Returns:</B><DD>the kind of this access rule</DL>
	</DD>
	</DL>
	<HR>

	<A NAME="ignoreIfBetter()"><!-- --></A><H3>
	ignoreIfBetter</H3>
	<PRE>
	boolean <B>ignoreIfBetter</B>()</PRE>
	<DL>
	<DD><p>Returns whether a type matching this rule should be ignored iff a type with
	the same qualified name can be found on a later includepath entry with a better
	accessibility.</p>
	<p>E.g. if a type p.X matches a rule K_NON_ACCESSIBLE \| IGNORE_IF_BETTER
	on a library entry 'lib1' and another type p.X also matches a rule
	K_DISCOURAGED on library entry 'lib2' ('lib2' being after 'lib1' on the
	includepath), then p.X from 'lib2' will be used and reported as
	discouraged.</p>
	<P>
	<DD><DL>

	<DT><B>Returns:</B><DD>whether a type matching this rule should be ignored iff a type
	with the same qualified name can be found on a later includepath
	entry with a better accessibility</DL>
	</DD>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IAccessRule.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../../org/eclipse/wst/jsdt/core/Flags.html" title="class in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>
	<A HREF="../../../../../org/eclipse/wst/jsdt/core/IBuffer.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IAccessRule.html" target="_top"><B>FRAMES</B></A>
	<A HREF="IAccessRule.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| CONSTR \| <A HREF="#method_summary">METHOD</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#field_detail">FIELD</A> \| CONSTR \| <A HREF="#method_detail">METHOD</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	</BODY>
	</HTML>