gnu.javax.net.ssl.provider

Class CompressionMethodList

Implemented Interfaces:
Iterable<E>

public final class CompressionMethodList
extends Object
implements Iterable<E>

A basic list interface to a list of compression methods in an SSL packet.

Nested Class Summary

class
CompressionMethodList.Iterator
An iterator for the elements in this list.

Constructor Summary

CompressionMethodList(ByteBuffer buffer)

Method Summary

boolean
equals(Object o)
Determine whether this Object is semantically equal to another Object.
CompressionMethod
get(int index)
Get the cipher suite at the specified index.
java.util.Iterator
iterator()
Returns an iterator for the collection.
void
put(int index, CompressionMethod method)
Set the CompressionMethod at the specified index.
void
setSize(int newSize)
Sets the size of this list.
int
size()
Return the number of elements in this list.
String
toString()
Convert this Object to a human-readable String.
String
toString(String prefix)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CompressionMethodList

public CompressionMethodList(ByteBuffer buffer)

Method Details

equals

public boolean equals(Object o)
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in interface Object
Parameters:
Returns:
whether this Object is semantically equal to another

get

public CompressionMethod get(int index)
Get the cipher suite at the specified index.
Parameters:
index - The index of the suite to get.
Returns:
The cipher suite at that index.
Throws:
IndexOutOfBoundsException - If the index is negative or is not less than size().

iterator

public java.util.Iterator iterator()
Returns an iterator for the collection.
Specified by:
iterator in interface Iterable<E>
Returns:
an iterator.

put

public void put(int index,
                CompressionMethod method)
Set the CompressionMethod at the specified index. The list must have sufficient size to hold the element (that is, index <= size ()).
Parameters:
index - The index to put the suite.
method - The CompressionMethod object.
Throws:
IndexOutOfBoundsException - If index is not less than @{link #size()}, or if it is negative.
NullPointerException - If suite is null.
ReadOnlyBufferException - If the underlying buffer is not writable.

setSize

public void setSize(int newSize)
Sets the size of this list. You must call this if you are adding elements to the list; calling put(int,gnu.jessie.provider.CipherSuite) does not expand the list size (the same goes for removing elements, as there is no remove method).
Parameters:
newSize - The new size of this list.
Throws:
IllegalArgumentException - If the new size is negative or greater than 32767, or if there is insufficient space for that many elements in the underlying buffer.
ReadOnlyBufferException - If the underlying buffer is not writable.

size

public int size()
Return the number of elements in this list.
Returns:
The size of this list.

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

toString

public String toString(String prefix)

CompressionMethodList.java -- A list of compression methods. Copyright (C) 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.