| <!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_10) on Wed Apr 30 14:47:11 PDT 2008 --> |
| <TITLE> |
| AbstractSetConstraint |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.jst.jsf.common.sets.constraint.AbstractSetConstraint class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="AbstractSetConstraint"; |
| } |
| </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/AbstractSetConstraint.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/jst/jsf/common/sets/constraint/AbstractMemberConstraint.html" title="class in org.eclipse.jst.jsf.common.sets.constraint"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/jst/jsf/common/sets/constraint/AbstractSetConstraint.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractSetConstraint.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.jst.jsf.common.sets.constraint</FONT> |
| <BR> |
| Class AbstractSetConstraint</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.jst.jsf.common.sets.constraint.AbstractSetConstraint</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/constraint/AbstractMemberConstraint.html" title="class in org.eclipse.jst.jsf.common.sets.constraint">AbstractMemberConstraint</A>, <A HREF="../../../../../../../org/eclipse/jst/jsf/core/set/constraint/MemberConstraint.html" title="class in org.eclipse.jst.jsf.core.set.constraint">MemberConstraint</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>AbstractSetConstraint</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Super-class of all axiomatic set constraints. |
| |
| A set constraint applies one or more pre-conditions on a set |
| and returns a diagnostic that flags whether or not the set |
| satisfies that constraint or not. |
| |
| <p><b>Provisional API - subject to change</b></p> |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/constraint/AbstractSetConstraint.html#AbstractSetConstraint()">AbstractSetConstraint</A></B>()</CODE> |
| |
| <BR> |
| </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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/constraint/AbstractSetConstraint.html#failsConstraint(org.eclipse.jst.jsf.common.sets.AxiomaticSet)">failsConstraint</A></B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</CODE> |
| |
| <BR> |
| Convenience method</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract Diagnostic</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/constraint/AbstractSetConstraint.html#isSatisfied(org.eclipse.jst.jsf.common.sets.AxiomaticSet)">isSatisfied</A></B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</CODE> |
| |
| <BR> |
| The following post-conditions must hold: |
| |
| 1) if the set satisfies the constraint with no caveats, |
| the returned diagnostic must in turn satisfy |
| Diagnostic.getSeverity() == Diagnostic.OK |
| |
| 2) if the set does not satisfy the constraint, the returned diagnostic |
| must satisfy Diagnostic.getSeverity() == Diagnostic.ERROR |
| |
| 3) if the set strictly satisfies the constraint but the constraint includes |
| parameters that can only be heuristically applied, the constraint may choose |
| to return a diagnostic where Diagnostic.getSeverity() == Diagnostic.WARNING |
| |
| The diagnostic returned should _never_ have any other severity but OK, ERROR or WARNING |
| |
| Algorithmically: |
| |
| Constraint is satisfied can be tested by Diagnostic.getSeverity() !</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/jst/jsf/common/sets/constraint/AbstractSetConstraint.html#passesConstraint(org.eclipse.jst.jsf.common.sets.AxiomaticSet)">passesConstraint</A></B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</CODE> |
| |
| <BR> |
| Convenience method</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AbstractSetConstraint()"><!-- --></A><H3> |
| AbstractSetConstraint</H3> |
| <PRE> |
| public <B>AbstractSetConstraint</B>()</PRE> |
| <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="isSatisfied(org.eclipse.jst.jsf.common.sets.AxiomaticSet)"><!-- --></A><H3> |
| isSatisfied</H3> |
| <PRE> |
| public abstract Diagnostic <B>isSatisfied</B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</PRE> |
| <DL> |
| <DD>The following post-conditions must hold: |
| |
| 1) if the set satisfies the constraint with no caveats, |
| the returned diagnostic must in turn satisfy |
| Diagnostic.getSeverity() == Diagnostic.OK |
| |
| 2) if the set does not satisfy the constraint, the returned diagnostic |
| must satisfy Diagnostic.getSeverity() == Diagnostic.ERROR |
| |
| 3) if the set strictly satisfies the constraint but the constraint includes |
| parameters that can only be heuristically applied, the constraint may choose |
| to return a diagnostic where Diagnostic.getSeverity() == Diagnostic.WARNING |
| |
| The diagnostic returned should _never_ have any other severity but OK, ERROR or WARNING |
| |
| Algorithmically: |
| |
| Constraint is satisfied can be tested by Diagnostic.getSeverity() != ERROR |
| Constraint is not satisfied can be tested by Diagnostic.getSeverity() == ERROR |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>set</CODE> - |
| <DT><B>Returns:</B><DD>a diagnostic object that contains information about whether |
| or not the constraint is satisfied for set. |
| <b>MUST NOT RETURN NULL</b></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="passesConstraint(org.eclipse.jst.jsf.common.sets.AxiomaticSet)"><!-- --></A><H3> |
| passesConstraint</H3> |
| <PRE> |
| public final boolean <B>passesConstraint</B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</PRE> |
| <DL> |
| <DD>Convenience method |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>set</CODE> - |
| <DT><B>Returns:</B><DD>true if the constraint is satisfied for set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="failsConstraint(org.eclipse.jst.jsf.common.sets.AxiomaticSet)"><!-- --></A><H3> |
| failsConstraint</H3> |
| <PRE> |
| public final boolean <B>failsConstraint</B>(<A HREF="../../../../../../../org/eclipse/jst/jsf/common/sets/AxiomaticSet.html" title="interface in org.eclipse.jst.jsf.common.sets">AxiomaticSet</A> set)</PRE> |
| <DL> |
| <DD>Convenience method |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>set</CODE> - |
| <DT><B>Returns:</B><DD>true if the constraint is <b>not</b> satisfied for set</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/AbstractSetConstraint.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/jst/jsf/common/sets/constraint/AbstractMemberConstraint.html" title="class in org.eclipse.jst.jsf.common.sets.constraint"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/jst/jsf/common/sets/constraint/AbstractSetConstraint.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractSetConstraint.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
