org.apache.commons.collections.DefaultMapEntry Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.collections;
import java.util.Map;
/**
* A default implementation of {@link java.util.Map.Entry}
*
* @deprecated Use the version in the keyvalue subpackage. Will be removed in v4.0
* @since Commons Collections 1.0
* @version $Revision$ $Date$
*
* @author James Strachan
* @author Michael A. Smith
* @author Neil O'Toole
* @author Stephen Colebourne
*
* @deprecated Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
*/
@Deprecated(since = "2021-04-30")
public class DefaultMapEntry implements Map.Entry, KeyValue {
/**
* The key
*/
private Object key;
/**
* The value
*/
private Object value;
/**
* Constructs a new DefaultMapEntry with a null key
* and null value.
*/
public DefaultMapEntry() {
super();
}
/**
* Constructs a new DefaultMapEntry with the given
* key and given value.
*
* @param entry the entry to copy, must not be null
* @throws NullPointerException if the entry is null
*/
public DefaultMapEntry(Map.Entry entry) {
super();
this.key = entry.getKey();
this.value = entry.getValue();
}
/**
* Constructs a new DefaultMapEntry with the given
* key and given value.
*
* @param key the key for the entry, may be null
* @param value the value for the entry, may be null
*/
public DefaultMapEntry(Object key, Object value) {
super();
this.key = key;
this.value = value;
}
// Map.Entry interface
// -------------------------------------------------------------------------
/**
* Gets the key from the Map Entry.
*
* @return the key
*/
public Object getKey() {
return key;
}
/**
* Sets the key stored in this Map Entry.
*
* This Map Entry is not connected to a Map, so only the local data is changed.
*
* @param key the new key
*/
public void setKey(Object key) {
this.key = key;
}
/**
* Gets the value from the Map Entry.
*
* @return the value
*/
public Object getValue() {
return value;
}
/**
* Sets the value stored in this Map Entry.
*
* This Map Entry is not connected to a Map, so only the local data is changed.
*
* @param value the new value
* @return the previous value
*/
public Object setValue(Object value) {
Object answer = this.value;
this.value = value;
return answer;
}
// Basics
// -----------------------------------------------------------------------
/**
* Compares this Map Entry with another Map Entry.
*
* Implemented per API documentation of {@link java.util.Map.Entry#equals(Object)}
*
* @param obj the object to compare to
* @return true if equal key and value
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof Map.Entry == false) {
return false;
}
Map.Entry other = (Map.Entry) obj;
return (getKey() == null ? other.getKey() == null : getKey().equals(other.getKey())) && (getValue() == null ? other.getValue() == null : getValue().equals(other.getValue()));
}
/**
* Gets a hashCode compatible with the equals method.
*
* Implemented per API documentation of {@link java.util.Map.Entry#hashCode()}
*
* @return a suitable hash code
*/
public int hashCode() {
return (getKey() == null ? 0 : getKey().hashCode()) ^ (getValue() == null ? 0 : getValue().hashCode());
}
/**
* Written to match the output of the Map.Entry's used in
* a {@link java.util.HashMap}.
* @since 3.0
*/
public String toString() {
return "" + getKey() + "=" + getValue();
}
}