Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.javax.crypto.keyring

Class EnvelopeEntry

Known Direct Subclasses:
CompressedEntry, MaskableEnvelopeEntry
public abstract class EnvelopeEntry
extends Entry
An envelope entry is a generic container for some number of primitive and other envelope entries.

Field Summary

protected EnvelopeEntry
containingEnvelope
The envelope that contains this one (if any).
protected List<E>
entries
The contained entries.

Fields inherited from class gnu.javax.crypto.keyring.Entry

payload, properties, type

Constructor Summary

EnvelopeEntry(int type)
EnvelopeEntry(int type, Properties properties)

Method Summary

void
add(Entry entry)
Adds an entry to this envelope.
boolean
containsAlias(String alias)
Tests if this envelope contains a primitive entry with the given alias.
boolean
containsEntry(Entry entry)
Tests if this envelope contains the given entry.
protected void
decodeEnvelope(DataInputStream in)
protected void
encodePayload()
List<E>
get(String alias)
Gets all primitive entries that have the given alias.
String
getAliasList()
Returns the list of all aliases contained by this envelope, separated by a semicolon (';').
List<E>
getEntries()
Returns a copy of all entries this envelope contains.
boolean
remove(Entry entry)
Removes the specified entry.
boolean
remove(String alias)
Removes all primitive entries that have the specified alias.
protected void
setContainingEnvelope(EnvelopeEntry e)
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class gnu.javax.crypto.keyring.Entry

defaultDecode, encode, encodePayload, getPayload, getProperties, toString

Methods inherited from class java.lang.Object

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

Field Details

containingEnvelope

protected EnvelopeEntry containingEnvelope
The envelope that contains this one (if any).

entries

protected List<E> entries
The contained entries.

Constructor Details

EnvelopeEntry

protected EnvelopeEntry(int type)

EnvelopeEntry

public EnvelopeEntry(int type,
                     Properties properties)

Method Details

add

public void add(Entry entry)
Adds an entry to this envelope.
Parameters:
entry - The entry to add.

containsAlias

public boolean containsAlias(String alias)
Tests if this envelope contains a primitive entry with the given alias.
Parameters:
alias - The alias to test.
Returns:
True if this envelope (or one of the contained envelopes) contains a primitive entry with the given alias.

containsEntry

public boolean containsEntry(Entry entry)
Tests if this envelope contains the given entry.
Parameters:
entry - The entry to test.
Returns:
True if this envelope contains the given entry.

decodeEnvelope

protected void decodeEnvelope(DataInputStream in)
            throws IOException

encodePayload

protected void encodePayload()
            throws IOException
Overrides:
encodePayload in interface Entry

get

public List<E> get(String alias)
Gets all primitive entries that have the given alias. If there are any masked entries that contain the given alias, they will be returned as well.
Parameters:
alias - The alias of the entries to get.
Returns:
A list of all primitive entries that have the given alias.

getAliasList

public String getAliasList()
Returns the list of all aliases contained by this envelope, separated by a semicolon (';').
Returns:
The list of aliases.

getEntries

public List<E> getEntries()
Returns a copy of all entries this envelope contains.
Returns:
All contained entries.

remove

public boolean remove(Entry entry)
Removes the specified entry.
Parameters:
entry - The entry.
Returns:
True if an entry was removed.

remove

public boolean remove(String alias)
Removes all primitive entries that have the specified alias.
Parameters:
alias - The alias of the entries to remove.
Returns:
true if alias was present and was successfully trmoved. Returns false if alias was not present in the list of aliases in this envelope.

setContainingEnvelope

protected void setContainingEnvelope(EnvelopeEntry e)

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 Entry
Returns:
the String representing this Object, which may be null
See Also:
getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)
EnvelopeEntry.java -- Copyright (C) 2003, 2006, 2010 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.

Overview Package Class Use Source Tree Index Deprecated About