com.landawn.abacus.util.MapEntity Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
/*
* Copyright (c) 2015, Haiyang Li.
*
* Licensed 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 com.landawn.abacus.util;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import com.landawn.abacus.annotation.Internal;
import com.landawn.abacus.annotation.SuppressFBWarnings;
/**
* This object is used to store the properties' values of an object. So it should not set or get value for other
* object's property.
*
* @author Haiyang Li
* @since 0.8
*/
@Internal
public final class MapEntity implements Serializable {
private static final long serialVersionUID = -6595007303962724540L;
private final String entityName;
private final Map values = new HashMap<>();
// For Kryo
MapEntity() {
this(N.EMPTY_STRING);
}
/**
*
*
* @param entityName
*/
public MapEntity(String entityName) {
this.entityName = entityName;
}
/**
*
*
* @param entityName
* @param props
*/
public MapEntity(String entityName, Map props) {
this(entityName);
set(props);
}
/**
*
* @param entityName
* @return
*/
public static MapEntity valueOf(String entityName) {
return new MapEntity(entityName);
}
/**
*
* @param entityName
* @param props
* @return
*/
public static MapEntity valueOf(String entityName, Map props) {
return new MapEntity(entityName, props);
}
/**
*
*
* @return
*/
public String entityName() {
return entityName;
}
/**
*
* @param
* @param propName
* @return
*/
@SuppressWarnings("unchecked")
public T get(String propName) {
if (NameUtil.isCanonicalName(entityName, propName)) {
return (T) values.get(NameUtil.getSimpleName(propName));
} else {
return (T) values.get(propName);
}
}
/**
*
* Node: To follow one of general design rules in {@code Abacus}, if there is a conversion behind when the source value is not assignable to the target type, put the {@code targetType} to last parameter of the method.
* Otherwise, put the {@code targetTpye} to the first parameter of the method.
*
* @param
* @param propName
* @param targetType
* @return
*/
@SuppressWarnings("unchecked")
public T get(String propName, Class targetType) {
Object propValue = get(propName);
if (propValue == null) {
propValue = N.defaultValueOf(targetType);
}
return N.convert(propValue, targetType);
}
/**
*
* @param propName
* @param propValue
* @return
*/
public MapEntity set(String propName, Object propValue) {
if (NameUtil.isCanonicalName(entityName, propName)) {
propName = NameUtil.getSimpleName(propName);
}
values.put(propName, propValue);
return this;
}
/**
*
* @param nameValues
*/
public void set(Map nameValues) {
for (Map.Entry entry : nameValues.entrySet()) {
set(entry.getKey(), entry.getValue());
}
}
/**
*
* @param propName
* @return
*/
public Object remove(String propName) {
if (values.size() == 0) {
return null;
}
if (NameUtil.isCanonicalName(entityName, propName)) {
propName = NameUtil.getSimpleName(propName);
}
return values.remove(propName);
}
/**
* Removes the all.
*
* @param propNames
*/
public void removeAll(Collection propNames) {
for (String propName : propNames) {
remove(propName);
}
}
/**
*
* @param propName
* @return true, if successful
*/
public boolean containsKey(String propName) {
if (values.size() == 0) {
return false;
}
if (NameUtil.isCanonicalName(entityName, propName)) {
return values.containsKey(NameUtil.getSimpleName(propName));
} else {
return values.containsKey(propName);
}
}
/**
* Returns the property names which have been set value.
*
* @return a collection of signed property names
* @see com.landawn.abacus.util.MapEntity#keySet()
*/
public Set keySet() {
return values.keySet();
}
/**
*
*
* @return
*/
public Set> entrySet() {
return values.entrySet();
}
/**
*
*
* @return
*/
public Map props() {
return values;
}
/**
*
*
* @return
*/
public int size() {
return values.size();
}
/**
* Checks if is empty.
*
* @return true, if is empty
*/
public boolean isEmpty() {
return size() == 0;
}
/**
*
*
* @return
*/
public MapEntity copy() {
return new MapEntity(this.entityName, this.values);
}
/**
*
*
* @return
*/
@Override
public int hashCode() {
int h = 17;
h = (h * 31) + entityName.hashCode();
return (h * 31) + values.hashCode();
}
/**
*
* @param obj
* @return true, if successful
*/
@SuppressFBWarnings
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof MapEntity other) {
return N.equals(entityName, other.entityName) && N.equals(values, other.values);
}
return false;
}
/**
*
*
* @return
*/
@Override
public String toString() {
return values.toString();
}
}