KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > corba > se > pept > transport > ContactInfoListIterator


1 /*
2  * @(#)ContactInfoListIterator.java 1.10 03/12/19
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package com.sun.corba.se.pept.transport;
9
10 import java.util.Iterator JavaDoc;
11
12 /**
13  * <code>ContactInfoIterator</code> is used to retrieve individual
14  * {@link com.sun.corba.se.pept.transport.ContactInfo ContactInfo}.
15  *
16  * @author Harold Carr
17  */
18 public interface ContactInfoListIterator
19     extends
20     Iterator JavaDoc
21 {
22     /**
23      * The underlying list for this iterator.
24      *
25      * @return The underlying list for this iterator.
26      */
27     public ContactInfoList getContactInfoList();
28
29     /**
30      * Used to report information to the iterator to be used
31      * in future invocations.
32      *
33      * @param contactInfo The
34      * {@link com.sun.corba.se.pept.transport.ContactInfo ContactInfo}
35      * obtained from this iterator which resulted in a successful invocation.
36      */
37     public void reportSuccess(ContactInfo contactInfo);
38
39     /**
40      * Used to report information to the iterator to be used
41      * in future invocations.
42      *
43      * @param contactInfo The
44      * {@link com.sun.corba.se.pept.transport.ContactInfo ContactInfo}
45      * in effect when an invocation exception occurs.
46      * @param exception The
47      * {@link java.lang.RuntimeException RuntimeException}.
48      *
49      * @return Returns true if the request should be retried.
50      */
51     public boolean reportException(ContactInfo contactInfo,
52                    RuntimeException JavaDoc exception);
53
54     /**
55      * The exception to report to the presentation block.
56      *
57      * @return If the iterator reaches the end before the invocation
58      * is successful one returns this exception (previously reported to
59      * the iterator via {@link #reportException}).
60                            
61      */
62     public RuntimeException JavaDoc getFailureException();
63 }
64
65 // End of file.
66
Popular Tags