org.osid.locale

Interface LocaleList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface LocaleList
extends OsidList

Like all OsidLists, LocaleList provides a means for accessing Locale elements sequentially either one at a time or many at a time. Examples:

       
       
       while (ll.hasNext()) {
            Locale locale = ll.getNextLocale();
       }
       
                   
       
  

or

       
       
       while (ll.hasNext()) {
            Locale[] locales = ll.getNextLocales(ll.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Locale	getNextLocale() Gets the next Locale in this list.
Locale[]	getNextLocales(long n) Gets the next set of Locale elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextLocale

Locale getNextLocale()
                     throws OperationFailedException

Gets the next Locale in this list.

Returns:

the next Locale in this list. The hasNext() method should be used to test that a next Locale is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextLocales

Locale[] getNextLocales(long n)
                        throws OperationFailedException

Gets the next set of Locale elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of Locale elements requested which must be less than or equal to available()

Returns:

an array of Locale elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.