Por favor, lembre-se que esta tradução da especificação é resultado de um projeto da comunidade java.net( https://jdk5-api-pt-br.dev.java.net/). A versão oficial da especificação é a versão na língua inglesa que pode ser encontrada em http://java.sun.com/j2se/1.5.0/docs/api/. Em caso de divergências, a versão predominante da especificação é a original em inglês.

Please note that this translation of the specification is the result of a java.net community project ( https://jdk5-api-pt-br.dev.java.net/ ). The official version of the specification is the US English language version which can be found at http://java.sun.com/j2se/1.5.0/docs/api/. In case of disputes, the authoritative version of the specification is the original, English document.

java.util
Interface SortedSet<E>

All Superinterfaces:

Collection<E>, Iterable<E>, Set<E>

All Known Implementing Classes:

TreeSet

public interface SortedSet<E>
extends Set<E>

Um set com adicionais garantias que seu iterator o percorrerá em ordem de elemento ascendente, classificado de acordo com o ordenamento natural de seus elementos (veja Comparable), ou por um comparador fornecido no momento de criação do sorted set. Várias operações adicionais são fornecidas para tirar proveito dessa ordenação. (Esta interface é o análogo set para SortedMap.)

Todos elementos inseridos em um sorted set precisam implementar a interface Comparable (ou ser aceito pelo Comparator especificado). Além disso, todos esses elementos precisam ser mutuamente comparáveis: e1.compareTo(e2) (ou comparator.compare(e1, e2)) não deve lançar ClassCastException para quaisquer elementos e1 e e2 no sorted set. A tentativa de violar essa restrição deve fazer com que a invocação ao método ou construtor violador lançe uma ClassCastException.

Note que o ordenamento mantido por um sorted set (mesmo que um comparador seja fornecido) precisa ser consistente com equals se o sorted set pretende implementar corretamente a interface Set. (Veja a inteface Comparable ou a interface Comparator para uma definição precisa de consistente com equals.) Isto porque a interface Set é definida em termos da operação equals, mas um sorted set pratica todas as comparações de elementos usando seus métodos compareTo (ou compare), de forma que dois elementos que são considerados iguais por esse método são, do ponto de vista do sorted set, iguais. O comportamento de um sorted set é bem definido mesmo se este ordenamento for inconsistente com equals; ele apenas falha em obedecer o contrato geral da interface Set.

Todas as classes de implementação de propósito geral de sorted set devem fornecer quatro construtores "padrões": 1) Um construtor sem argumentos, que cria um sorted set vazio classificado de acordo com o ordenamento natural de seus elementos. 2) Um construtor com um único argumento do tipo Comparator, que cria um sorted set vazio classificado de acordo com o comparador especificado. 3) Um construtor com um único argumento do tipo Collection, que cria um novo sorted set com os mesmos elementos do seu argumento, classificados de acordo com o ordenamento natural desses elementos. 4) Um construtor com um único argumento do tipo SortedSet, que cria um novo sorted set com os mesmos elementos e o mesmo ordenamento do sorted set de entrada. Não há como garantir essa recomendação (já que interfaces não podem ter construtores) mas a implementação do JDK o faz por meio da classe TreeSet.

Esta interface é um membro do Java Collections Framework.

Since:

1.2

See Also:

Set, TreeSet, SortedMap, Collection, Comparable, Comparator, ClassCastException

Method Summary

Comparator<? super E>	comparator() Retorna o comparador associado a este sorted set, ou null se ele usa o ordenamento natural de seus elementos.
E	first() Retorna o primeiro (inferior) elemento atualmente neste sorted set.
SortedSet<E>	headSet(E toElement) Retorna uma visão da porção deste sorted set cujo elementos são estritamente menores que toElement.
E	last() Retorna o último (superior) elemento atualmente neste sorted set.
SortedSet<E>	subSet(E fromElement, E toElement) Retorna uma visão da porção deste sorted set cujo elementos vão de fromElement, inclusive, até toElement, exclusivo.
SortedSet<E>	tailSet(E fromElement) Retorna uma visão da porção deste sorted set cujo elementos são maiores ou iguais à fromElement.

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

comparator

Comparator<? super E> comparator()

Retorna o comparador associado a este sorted set, ou null se ele usa o ordenamento natural de seus elementos.

Returns:

o comparador associado a este sorted set, ou null se ele usa o ordenamento natural de seus elementos.

subSet

SortedSet<E> subSet(E fromElement,
                    E toElement)

Retorna uma visão da porção deste sorted set cujo elementos vão de fromElement, inclusive, até toElement, exclusivo. (se fromElement e toElement forem iguais, o sorted set retornado será vazio.) O sorted set retornado é suportado por este sorted set, portanto, alterações no sorted set retornado serão refletidas neste sorted set, e vice-versa. O sorted set retornado suporta todas as operações de set opcionais que este sorted set suporta.

O sorted set retornado por este método deve lançar uma IllegalArgumentException se o usuário tentar inserir um elemento fora dos limites especificados.

Nota: este método sempre retorna uma coleção meia-aberta (que inclui seu limite inferior mas não seu limite superior). Se você necessita uma coleção fechada (que inclui ambos os extremos), e o tipo do elemento permite o cálculo do sucessor de um dado valor, simplesmente solicite a partir do limiteInferior até sucessor(limiteSuperior). Por exemplo, suponhamos que s seja um sorted set de strings. O idioma a seguir obtém uma visão contendo todas as strings em s de inferior até superior, inclusive:

 SortedSet sub = s.subSet(inferior, superior+"\0");
 

Uma técnica similar pode ser usada para gerar uma coleção aberta (que não contém os extremos). O idioma a seguir obtém uma visão contendo todas as strings em s de inferior até superior, exclusivo:

 SortedSet sub = s.subSet(inferior+"\0", superior);
 

Parameters:

fromElement - limite inferior (inclusive) do subSet.

toElement - limite superior (exclusivo) do subSet.

Returns:

uma visão deste sorted set, nos limites especificados.

Throws:

ClassCastException - se fromElement e toElement não puderem ser comparados um com o outro usando o comparador deste set (ou, se o set não tiver comparador, usando ordenamento natural). Implementações podem, mas não são obrigadas a lançar essa exceção se fromElement ou toElement não puderem ser comparados com elementos atualmente no set.

IllegalArgumentException - se fromElement for maior que toElement; ou se este set for ele próprio um subSet, headSet, ou tailSet, e fromElement ou toElement não estiverem dentro dos limites especificados para o subSet, headSet, ou tailSet.

NullPointerException - se fromElement ou toElement for null e este sorted set não tolerar elementos null.

headSet

SortedSet<E> headSet(E toElement)

Retorna uma visão da porção deste sorted set cujo elementos são estritamente menores que toElement. O sorted set retornado é suportado por este sorted set, portanto, alterações no sorted set retornado serão refletidas neste sorted set, e vice-versa. O sorted set retornado suporta todas as operações de set opcionais que este sorted set suporta.

O sorted set retornado por este método deve lançar uma IllegalArgumentException se o usuário tentar inserir um elemento fora do limite especificado.

Nota: este método sempre retorna uma visão que não contém seu limite superior. Se você necessita uma visão que contenha este limite superior, e o tipo do elemento permite o cálculo do sucessor de um dado valor, simplesmente solicite um headSet limitado por sucessor(limiteSuperior). Por exemplo, suponhamos que s seja um sorted set de strings. O idioma a seguir obtém uma visão contendo todas as strings em s que são menores que, ou igual à superior:

    SortedSet head = s.headSet(superior+"\0");

Parameters:

toElement - limite superior (exclusivo) do headSet.

Returns:

uma visão do limite inicial deste sorted set.

Throws:

ClassCastException - se toElement não for compatível com o comparador deste set (ou, se o set não tiver comparador, se toElement não implementar Comparable). Implementações podem, mas não são obrigadas a lançar essa exceção se toElement não puder ser comparado com elementos atualmente neste set.

NullPointerException - se toElement for null e este sorted set não tolerar elementos null.

IllegalArgumentException - se este set for ele próprio um subSet, headSet, ou tailSet, e toElement não estiver dentro do limite especificado para o subSet, headSet, or tailSet.

tailSet

SortedSet<E> tailSet(E fromElement)

Retorna uma visão da porção deste sorted set cujo elementos são maiores ou iguais à fromElement. O sorted set retornado é suportado por este sorted set, portanto, alterações no sorted set retornado são refletidas neste sorted set, e vice-versa. O sorted set retornado suporta todas as operações de set opcionais que este sorted set suporta.

O sorted set retornado por este método deve lançar uma IllegalArgumentException se o usuário tentar inserir um elemento fora do limite especificado.

Nota: este método sempre retorna uma visão que contém seu limite inferior. Se você necessita uma visão que não contenha este limite inferior, e o tipo do elemento permite o cálculo do sucessor de um dado valor, simplesmente solicite um tailSet limitado por sucessor(limiteInferior). Por exemplo, suponhamos que s seja um sorted set de strings. O idioma a seguir obtém uma visão contendo todas as strings em s que forem estritamente maiores que inferior:

    SortedSet tail = s.tailSet(inferior+"\0");

Parameters:

fromElement - limite inferior (inclusive) do tailSet.

Returns:

uma visão do limite final deste sorted set.

Throws:

ClassCastException - se fromElement não for compatível com o comparador deste set (ou, se o set não tiver comparador, se fromElement não implementar Comparable). Implementações podem, mas não são obrigadas a lançar essa exceção se fromElement não puder ser comparado com elementos atualmente neste set.

NullPointerException - se fromElement for null e este sorted set não tolerar elementos null.

IllegalArgumentException - se este set for ele próprio um subSet, headSet, or tailSet, e fromElement não estiver dentro do limite especificado para o subSet, headSet, or tailSet.

first

E first()

Retorna o primeiro (inferior) elemento atualmente neste sorted set.

Returns:

o primeiro (inferior) elemento atualmente neste sorted set.

Throws:

NoSuchElementException - caso sorted set esteja vazio.

last

E last()

Retorna o último (superior) elemento atualmente neste sorted set.

Returns:

o último (superior) elemento atualmente neste sorted set.

Throws:

NoSuchElementException - caso sorted set esteja vazio.