repeatrule.html

J2ME手机编程规范JSR-75文档

<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.APRIL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="MAY"><!-- --></A><H3>
MAY</H3>
<PRE>
public static final int <B>MAY</B></PRE>
<DL>
<DD>Constant for the month of May used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.MAY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="JUNE"><!-- --></A><H3>
JUNE</H3>
<PRE>
public static final int <B>JUNE</B></PRE>
<DL>
<DD>Constant for the month of June used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.JUNE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="JULY"><!-- --></A><H3>
JULY</H3>
<PRE>
public static final int <B>JULY</B></PRE>
<DL>
<DD>Constant for the month of July used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.JULY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="AUGUST"><!-- --></A><H3>
AUGUST</H3>
<PRE>
public static final int <B>AUGUST</B></PRE>
<DL>
<DD>Constant for the month of August used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.AUGUST">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SEPTEMBER"><!-- --></A><H3>
SEPTEMBER</H3>
<PRE>
public static final int <B>SEPTEMBER</B></PRE>
<DL>
<DD>Constant for the month of September used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.SEPTEMBER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="OCTOBER"><!-- --></A><H3>
OCTOBER</H3>
<PRE>
public static final int <B>OCTOBER</B></PRE>
<DL>
<DD>Constant for the month of October used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.OCTOBER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="NOVEMBER"><!-- --></A><H3>
NOVEMBER</H3>
<PRE>
public static final int <B>NOVEMBER</B></PRE>
<DL>
<DD>Constant for the month of November used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.NOVEMBER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DECEMBER"><!-- --></A><H3>
DECEMBER</H3>
<PRE>
public static final int <B>DECEMBER</B></PRE>
<DL>
<DD>Constant for the month of December used with
 <code>MONTH_IN_YEAR</code> field.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.microedition.pim.RepeatRule.DECEMBER">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="RepeatRule()"><!-- --></A><H3>
RepeatRule</H3>
<PRE>
public <B>RepeatRule</B>()</PRE>
<DL>
<DD>Default constructor.
<P>
</DL>

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

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

<A NAME="dates(long, long, long)"><!-- --></A><H3>
dates</H3>
<PRE>
public java.util.Enumeration <B>dates</B>(long&nbsp;startDate,
                                   long&nbsp;subsetBeginning,
                                   long&nbsp;subsetEnding)</PRE>
<DL>
<DD>Returns an Enumeration of dates on which an Event would occur.  A start
 date is specified form which the repeating rule is applied to generate
 dates.  Then a beginning date and a start date is also provided to
 return only a subset of all possible occurrences of an Event within the
 given timeframe.  The sequence of the items is by date.  Exceptional dates
 are not included in the returned Enumeration. <BR>
 For example, an Event may happen every Monday during a year starting on
 January 1st.  However, one wants to know occurrences of the Event during
 the month of June only.  The startDate parameter specifies the anchor point
 for the Event from which it begins repeating, and the subsetBeginning and
 subsetEnding parameters would limit the Events returned to those only in
 June in this example.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startDate</CODE> - the start date for the sequence, from which the repeat
           rule is applied to generate possible occurrence dates.  This
           value must be expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).<DD><CODE>subsetBeginning</CODE> - the beginning date of the period for which events
           should be returned. This value must be expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).<DD><CODE>subsetEnding</CODE> - the end date of the period for which events should
           be returned. This value must be expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
<DT><B>Returns:</B><DD>an Enumeration of dates for the given parameters, with the
           Enumeration containing <code>java.util.Date</code> instances.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>beginning</code> is greater
           than <code>ending</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="addExceptDate(long)"><!-- --></A><H3>
addExceptDate</H3>
<PRE>
public void <B>addExceptDate</B>(long&nbsp;date)</PRE>
<DL>
<DD>Add a Date for which this RepeatRule should not occur.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the date to add to the list of except dates, expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).</DL>
</DD>
</DL>
<HR>

<A NAME="removeExceptDate(long)"><!-- --></A><H3>
removeExceptDate</H3>
<PRE>
public void <B>removeExceptDate</B>(long&nbsp;date)</PRE>
<DL>
<DD>Remove a Date for which this RepeatRule should not occur. If the
 date was in the list of except dates, it is removed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>date</CODE> - the date to remove from the list of except dates expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).</DL>
</DD>
</DL>
<HR>

<A NAME="getExceptDates()"><!-- --></A><H3>
getExceptDates</H3>
<PRE>
public java.util.Enumeration <B>getExceptDates</B>()</PRE>
<DL>
<DD>Returns the Dates for which this RepeatRule should not occur.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an Enumeration of dates for which this RepeatRule should not
           occur, with the
           Enumeration containing <code>java.util.Date</code> instances.</DL>
</DD>
</DL>
<HR>

<A NAME="getInt(int)"><!-- --></A><H3>
getInt</H3>
<PRE>
public int <B>getInt</B>(int&nbsp;field)</PRE>
<DL>
<DD>Retrieves an integer field. The field values can be one of <code>COUNT,
 DAY_IN_MONTH, FREQUENCY, INTERVAL, MONTH_IN_YEAR, WEEK_IN_MONTH,
 DAY_IN_WEEK, DAY_IN_YEAR</code>.  <A HREF="../../../javax/microedition/pim/RepeatRule.html#getFields()"><CODE>getFields()</CODE></A> should be checked
 prior to invoking the method to ensure the field has a value associated
 with it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field to get, for example <code>COUNT</code>.
<DT><B>Returns:</B><DD>an int representing the value of the field.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not one of the
           the valid RepeatRule fields for this method.
<DD><CODE><A HREF="../../../javax/microedition/pim/FieldEmptyException.html">FieldEmptyException</A></CODE> - if the field does is a valid integer field
           but does not have any data values assigned to it.</DL>
</DD>
</DL>
<HR>

<A NAME="setInt(int, int)"><!-- --></A><H3>
setInt</H3>
<PRE>
public void <B>setInt</B>(int&nbsp;field,
                   int&nbsp;value)</PRE>
<DL>
<DD>Sets an integer field. The field value can be one
 of <code>COUNT, DAYNUMBER, FREQUENCY, INTERVAL, MONTH_IN_YEAR,
 WEEK_IN_MONTH, DAY_IN_WEEK, DAY_IN_YEAR</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field to set, for example <code>COUNT</code>.<DD><CODE>value</CODE> - The value to set the field to.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not one of the
           the valid RepeatRule fields for this method, or the value
           provided is not a valid value for the given field.</DL>
</DD>
</DL>
<HR>

<A NAME="getDate(int)"><!-- --></A><H3>
getDate</H3>
<PRE>
public long <B>getDate</B>(int&nbsp;field)</PRE>
<DL>
<DD>Retrieves a Date field. The field value is currently limited to
 <code>END</code>.  <A HREF="../../../javax/microedition/pim/RepeatRule.html#getFields()"><CODE>getFields()</CODE></A> should be checked prior to
 invoking the method to ensure the field has a value associated with it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field to get.
<DT><B>Returns:</B><DD>a Date representing the value of the field, expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not one of the
          the valid RepeatRule fields for this method.
<DD><CODE><A HREF="../../../javax/microedition/pim/FieldEmptyException.html">FieldEmptyException</A></CODE> - if the field does is a valid date field
          but does not have any data values assigned to it.</DL>
</DD>
</DL>
<HR>

<A NAME="setDate(int, long)"><!-- --></A><H3>
setDate</H3>
<PRE>
public void <B>setDate</B>(int&nbsp;field,
                    long&nbsp;value)</PRE>
<DL>
<DD>Sets a Date field. The field value is currently limited to
 <code>END</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>field</CODE> - The field to set.<DD><CODE>value</CODE> - The value to set the field to, expressed
           in the same long value format as java.util.Date, which is
           milliseconds since the epoch (00:00:00 GMT, January 1, 1970).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if field is not one of the
          the valid RepeatRule fields for this method.</DL>
</DD>
</DL>
<HR>

<A NAME="getFields()"><!-- --></A><H3>
getFields</H3>
<PRE>
public int[] <B>getFields</B>()</PRE>
<DL>
<DD>Returns a list of fields that currently have values assigned to it.  If
 a field is not "set", the field will not be included in the return value.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an array of fields that have values currently assigned to them.
          If no fields have values set, an array of zero length is
          returned.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <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>
Proposed Final Draft<br>Rev. 0.24</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../javax/microedition/pim/PIM.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RepeatRule.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;
<SCRIPT>
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size=-1>Copyright &copy; 2002-2003 PalmSource, Inc.  All Rights Reserved.<br>Java is a trademark of Sun Microsystems, Inc.</font>
</BODY>
</HTML>