gnu.javax.crypto.keyring

Class Properties

Implemented Interfaces:
Cloneable

public class Properties
extends Object
implements Cloneable

A set of (name => value) pairs used in keyring entries. Keys and values are simple strings, with the key never being empty and always treated case-insensitively.

Constructor Summary

Properties()
Creates a new properties object.

Method Summary

void
clear()
Removes all properties from this object.
Object
clone()
Creates a copy of this properties object.
boolean
containsKey(String key)
Tests if this object contains a given property name.
boolean
containsValue(String value)
Tests if this object contains a given property value.
void
decode(DataInputStream in)
Decodes a set of properties from the given input stream.
void
encode(DataOutputStream out)
Encodes this set of properties to the given output stream.
String
get(String key)
Returns the value mapped by the given key, or null if there is no such mapping.
String
put(String key, String value)
Adds a new property to this object.
String
remove(String key)
Removes a key and its value from this object.
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class java.lang.Object

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

Constructor Details

Properties

public Properties()
Creates a new properties object.

Method Details

clear

public void clear()
Removes all properties from this object.

clone

public Object clone()
Creates a copy of this properties object.
Overrides:
clone in interface Object
Returns:
The copy.

containsKey

public boolean containsKey(String key)
Tests if this object contains a given property name.
Parameters:
key - The key to test.
Returns:
True if this object contains the given key.

containsValue

public boolean containsValue(String value)
Tests if this object contains a given property value.
Parameters:
value - The value to test.
Returns:
True if this object contains the given value.

decode

public void decode(DataInputStream in)
            throws IOException
Decodes a set of properties from the given input stream.
Parameters:
in - The input stream.
Throws:
IOException - If an I/O error occurs.

encode

public void encode(DataOutputStream out)
            throws IOException
Encodes this set of properties to the given output stream.
Parameters:
out - The output stream to encode to.
Throws:
IOException - If an I/O error occurs.

get

public String get(String key)
Returns the value mapped by the given key, or null if there is no such mapping.
Parameters:
key -

put

public String put(String key,
                  String value)
Adds a new property to this object.
Parameters:
key - The key, which can neither be null nor empty.
value - The value, which cannot be null.
Returns:
The old value mapped by the key, if any.
Throws:
IllegalArgumentException - If either the key or value parameter is null, or if the key is empty.

remove

public String remove(String key)
Removes a key and its value from this object.
Parameters:
key - The key of the property to remove.
Returns:
The old value mapped by the key, if any.

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

Properties.java -- Copyright (C) 2003, 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.