Skip to content
Snippets Groups Projects
Select Git revision
  • ca14743b43ad84ee36d1a913ed813808e518ec77
  • dev default protected
  • main protected
  • feature/better-placeholders
  • 0.3.0
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.1
  • 0.2
  • 0.1
11 results

Ignore.html

Blame
  • Ignore.html 9.63 KiB
    <!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.6.0_33) on Mon Aug 27 16:21:35 CEST 2012 -->
    <TITLE>
    Ignore (JUnit API)
    </TITLE>
    
    <META NAME="date" CONTENT="2012-08-27">
    
    <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
    
    <SCRIPT type="text/javascript">
    function windowTitle()
    {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Ignore (JUnit API)";
        }
    }
    </SCRIPT>
    <NOSCRIPT>
    </NOSCRIPT>
    
    </HEAD>
    
    <BODY BGCOLOR="white" onload="windowTitle();">
    <HR>
    
    
    <!-- ========= 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="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-all.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/junit/FixMethodOrder.html" title="annotation in org.junit"><B>PREV CLASS</B></A>&nbsp;
    &nbsp;<A HREF="../../org/junit/Rule.html" title="annotation in org.junit"><B>NEXT CLASS</B></A></FONT></TD>
    <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
      <A HREF="../../index.html?org/junit/Ignore.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    &nbsp;<A HREF="Ignore.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;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
    <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</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.junit</FONT>
    <BR>
    Annotation Type Ignore</H2>
    <HR>
    <DL>
    <DT><PRE><FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>)
    <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>={<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</A>})
    </FONT>public @interface <B>Ignore</B></DL>
    </PRE>
    
    <P>
    <p>Sometimes you want to temporarily disable a test or a group of tests. Methods annotated with 
     <A HREF="../../org/junit/Test.html" title="annotation in org.junit"><CODE>Test</CODE></A> that are also annotated with <code>&#064;Ignore</code> will not be executed as tests.
     Also, you can annotate a class containing test methods with <code>&#064;Ignore</code> and none of the containing 
     tests will be executed. Native JUnit 4 test runners should report the number of ignored tests along with the 
     number of tests that ran and the number of tests that failed.</p>
     
     For example:
     <pre>
        &#064;Ignore &#064;Test public void something() { ...
     </pre>
     &#064;Ignore takes an optional default parameter if you want to record why a test is being ignored:<br/>
     <pre>
        &#064;Ignore("not ready yet") &#064;Test public void something() { ...
     </pre>
     &#064;Ignore can also be applied to the test class:<br/>
     <pre>
                    &#064;Ignore public class IgnoreMe {
                            &#064;Test public void test1() { ... }
                            &#064;Test public void test2() { ... }
                    }
     </pre>
    <P>
    
    <P>
    <DL>
    <DT><B>Since:</B></DT>
      <DD>4.0</DD>
    </DL>
    <HR>
    
    <P>
    <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
    
    <A NAME="annotation_type_optional_element_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>Optional Element Summary</B></FONT></TH>
    </TR>
    <TR BGCOLOR="white" CLASS="TableRowColor">
    <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
    <TD><CODE><B><A HREF="../../org/junit/Ignore.html#value()">value</A></B></CODE>
    
    <BR>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The optional reason why the test is ignored.</TD>
    </TR>
    </TABLE>
    &nbsp;
    <P>
    <A NAME="value()"><!-- --></A><H3>
    value</H3>
    <PRE>
    public abstract <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>value</B></PRE>
    <DL>
    <DD>The optional reason why the test is ignored.
    <P>
    <DD><DL>
    </DL>
    </DD>
    <DD><DL>
    </DL>
    <DL>
    <DT><B>Default:</B><DD>""</DD>
    </DL>
    </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="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-all.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/junit/FixMethodOrder.html" title="annotation in org.junit"><B>PREV CLASS</B></A>&nbsp;
    &nbsp;<A HREF="../../org/junit/Rule.html" title="annotation in org.junit"><B>NEXT CLASS</B></A></FONT></TD>
    <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
      <A HREF="../../index.html?org/junit/Ignore.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    &nbsp;<A HREF="Ignore.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;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
    <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
    </TR>
    </TABLE>
    <A NAME="skip-navbar_bottom"></A>
    <!-- ======== END OF BOTTOM NAVBAR ======= -->
    
    <HR>
    
    </BODY>
    </HTML>