org.jscsi.parser.datasegment.SettingsMap Maven / Gradle / Ivy
/**
* Copyright (c) 2012, University of Konstanz, Distributed Systems Group All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or other materials provided with the
* distribution. * Neither the name of the University of Konstanz nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jscsi.parser.datasegment;
import java.nio.ByteBuffer;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* SettingsMap
*
* This class stores all text parameters and allows an easy access to these.
*
* @author Volker Wildi
*/
public final class SettingsMap {
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** The Logger interface. */
private static final Logger LOGGER = LoggerFactory.getLogger(SettingsMap.class);
/** Delimiter between the key and the value of a key-value-pair. */
private static final String KEY_VALUE_DELIMITER = "=";
/** Delimiter between two key-value-pairs. */
private static final String PAIR_DELIMITER = "\0";
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** This map contains all settings. */
private final Map settingsMap;
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Default constructor to create a new, empty SettingsMap object.
*/
public SettingsMap () {
settingsMap = new LinkedHashMap();
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Adds a parameter to this SettingsMap.
*
* @param textKey The name of the parameter to add.
* @param textValue The value of the parameter to add.
*/
public final void add (final OperationalTextKey textKey, final String textValue) {
if (textKey == null || textValue == null) { throw new IllegalArgumentException("This is not a valid operation text key."); }
settingsMap.put(textKey, textValue);
}
/**
* Returns the value of the given parameter, which is not parsed.
*
* @param textKey The name of the parameter.
* @return The value of this parameter.
*/
public final String get (final OperationalTextKey textKey) {
if (textKey == null) { throw new NullPointerException(); }
return settingsMap.get(textKey);
}
/**
* Removes the given parameter from this SettingsMap.
*
* @param textKey The name of the parameter.
* @return The value of the removed parameter.
*/
public final String remove (final OperationalTextKey textKey) {
if (textKey == null) { throw new NullPointerException(); }
if (!settingsMap.containsKey(textKey)) { throw new IllegalArgumentException("This entry does not exists."); }
return settingsMap.remove(textKey);
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Update the stored value with the given one. The result is dependant on the IResultFunction instance.
*
* @param textKey The OperationalTextKey to update.
* @param newTextValue The new value, which is interpreted as response.
* @param resultFunction The IResultFunction to use to obtaining the result.
*/
public final void update (final OperationalTextKey textKey, final String newTextValue, final IResultFunction resultFunction) {
final String oldValue = settingsMap.get(textKey);
String updatedValue;
if (oldValue == null) {
if (LOGGER.isWarnEnabled()) {
LOGGER.warn("Update old value failed: No old value for key " + textKey.value() + ".");
}
updatedValue = newTextValue;
} else {
updatedValue = resultFunction.result(oldValue, newTextValue);
}
settingsMap.put(textKey, updatedValue);
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* This method compares the text parameters of this object with the ones given by a Map
* object.
*
* @param aSettingsMap A SettingsMap object, which should be used for the comparsion.
* @return true, if the all keys are equal with the ones of the aSettingsMap object. Else
* false.
*/
public final boolean equals (final SettingsMap aSettingsMap) {
// alias check
if (this == aSettingsMap) { return true; }
if (aSettingsMap != null) { return equals(aSettingsMap.settingsMap); }
return false;
}
/**
* This method compares the text parameters of this object with the ones given by a Map
* object.
*
* @param aMap A Map<String, String> object, which should be used for the comparsion.
* @return true, if the all keys are equal with the ones of the aMap object. Else
* false.
*/
public final boolean equals (final Map aMap) {
// alias check
if (this.settingsMap == aMap) { return true; }
do {
if (aMap == null) {
break;
}
if (settingsMap.size() != aMap.size()) {
// LOGGER.error("The maps have different sizes.");
break;
}
OperationalTextKey key;
String value;
for (Map.Entry e : aMap.entrySet()) {
key = e.getKey();
value = e.getValue();
if (!settingsMap.containsKey(key)) {
// LOGGER.error("KeyValuePair does not contain a key: " +
// key);
return false;
}
if (settingsMap.get(key).compareTo(value) != 0) {
// LOGGER
// .error("KeyValuePair does not pass the compareTo method with key "
// + key);
// LOGGER.error("Value in KeyValuePair: " +
// settingsMap.get(key));
// LOGGER.error("Value should be: " + value);
return false;
}
}
return true;
} while (false);
return false;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Returns a set of an key-value pair of this OperationTextKeys object.
*
* @return a set view of the mappings (key-value-pair) contained in this map.
*/
public final Set> entrySet () {
return settingsMap.entrySet();
}
/** {@inheritDoc} */
@Override
public final int hashCode () {
return settingsMap.hashCode();
}
/** {@inheritDoc} */
@Override
public final String toString () {
final StringBuilder sb = new StringBuilder();
for (Map.Entry e : settingsMap.entrySet()) {
sb.append(e.getKey().value());
sb.append(KEY_VALUE_DELIMITER);
sb.append(e.getValue());
sb.append(",");
}
return sb.toString();
}
/**
* Removes all stored settings from this SettingsMap.
*/
public final void clear () {
settingsMap.clear();
}
/**
* Returns a buffer of the serialized key-value pairs, which are contained in this instance.
*
* @return The serialized key-value pairs.
*/
public final ByteBuffer asByteBuffer () {
final StringBuilder sb = new StringBuilder();
for (Map.Entry e : settingsMap.entrySet()) {
sb.append(e.getKey().value());
sb.append(KEY_VALUE_DELIMITER);
sb.append(e.getValue());
sb.append(PAIR_DELIMITER);
}
return ByteBuffer.wrap(sb.toString().getBytes());
}
public int size () {
return settingsMap.size();
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
}