com.baidu.bjf.remoting.protobuf.utils.FieldInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jprotobuf Show documentation
Show all versions of jprotobuf Show documentation
A useful utility library for java programmer using google protobuf.
/*
* Copyright (c) Baidu Inc. All rights reserved.
*
* 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 com.baidu.bjf.remoting.protobuf.utils;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.WildcardType;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.baidu.bjf.remoting.protobuf.FieldType;
/**
* combined class of {@link Field} and @Protobuf annotation value.
*
* @author xiemalin
* @since 1.0.7
*/
public class FieldInfo {
/** The field. */
private Field field;
/** The required. */
boolean required;
/** field description. */
private String description;
/** The wildcard type. */
private boolean wildcardType = false;
/**
* Set field order. It starts at 1;
*
* @return field order.
*/
int order;
/** the type used for List or Map key generic type. */
private Class genericKeyType;
/** the type used for Map value generic type. */
private Class genericeValueType;
/**
* field type.
*
* @return field type
*/
FieldType fieldType;
/** The is list. */
private boolean isList;
/** The is map. */
private boolean isMap;
/** The packed. */
private boolean packed;
/** The use type. */
private boolean useType;
/** The use as type. */
private Class useAsType;
/**
* Sets the use as type.
*
* @param useAsType the new use as type
*/
public void setUseAsType(Class useAsType) {
this.useAsType = useAsType;
}
/**
* Gets the use as type.
*
* @return the use as type
*/
public Class getUseAsType() {
return useAsType;
}
/**
* Sets the use type.
*
* @param useType the new use type
*/
public void setUseType(boolean useType) {
this.useType = useType;
}
/**
* Checks if is use type.
*
* @return true, if is use type
*/
public boolean isUseType() {
return useType;
}
/**
* Checks if is wildcard type.
*
* @return the wildcard type
*/
public boolean isWildcardType() {
return wildcardType;
}
/**
* To check if type of {@link Field} is assignable from {@link List}.
*
* @param field the field
* @return true if is assignable from {@link List}
*/
private void checkListMapType(Field field) {
Class cls = field.getType();
boolean needCheckGenericType = false;
if (List.class.isAssignableFrom(cls) || Set.class.isAssignableFrom(cls)) {
// if check is list ignore check
isList = true;
needCheckGenericType = true;
}
if (Map.class.isAssignableFrom(cls)) {
// if check is list ignore check
isMap = true;
needCheckGenericType = true;
}
if (!needCheckGenericType) {
return;
}
Type type = field.getGenericType();
if (type instanceof ParameterizedType) {
ParameterizedType ptype = (ParameterizedType) type;
Type[] actualTypeArguments = ptype.getActualTypeArguments();
if (actualTypeArguments != null) {
int length = actualTypeArguments.length;
// validate
if (isList) {
if (length != 1) {
throw new RuntimeException(
"List must use generic definiation like List, please check field name '"
+ field.getName() + " at class " + field.getDeclaringClass().getName());
}
} else if (isMap) {
if (length != 2) {
throw new RuntimeException(
"Map must use generic definiation like Map, please check field name '"
+ field.getName() + " at class " + field.getDeclaringClass().getName());
}
}
Type targetType = actualTypeArguments[0];
if (targetType instanceof Class) {
genericKeyType = (Class) targetType;
} else if (targetType instanceof ParameterizedType) {
boolean mapKey = false;
if (isMap) {
mapKey = true;
}
throw new RuntimeException(noSubParameterizedType(field, mapKey));
} else if (WildcardType.class.isAssignableFrom(targetType.getClass())) {
wildcardType = true;
WildcardType wildcardType = (WildcardType) targetType;
Type[] upperBounds = wildcardType.getUpperBounds();
if (upperBounds != null && upperBounds.length == 1) {
if (upperBounds[0] instanceof Class ) {
genericKeyType = (Class) upperBounds[0];
}
}
}
if (actualTypeArguments.length > 1) {
targetType = actualTypeArguments[1];
if (targetType instanceof Class) {
genericeValueType = (Class) targetType;
} else if (targetType instanceof ParameterizedType) {
boolean mapKey = false;
if (isMap) {
mapKey = true;
}
throw new RuntimeException(noSubParameterizedType(field, mapKey));
} else if (WildcardType.class.isAssignableFrom(targetType.getClass())) {
wildcardType = true;
WildcardType wildcardType = (WildcardType) targetType;
Type[] upperBounds = wildcardType.getUpperBounds();
if (upperBounds != null && upperBounds.length == 1) {
if (upperBounds[0] instanceof Class ) {
genericeValueType = (Class) upperBounds[0];
}
}
}
}
}
}
}
/**
* No sub parameterized type.
*
* @param field the field
* @param listOrMap the list or map
* @return the string
*/
private String noSubParameterizedType(Field field, boolean listOrMap) {
String key = "List";
if (listOrMap) {
key = "Map";
}
return key + " can not has sub parameterized type please check field name '" + field.getName() + " at class "
+ field.getDeclaringClass().getName();
}
/**
* Instantiates a new field info.
*
* @param field the field
*/
public FieldInfo(Field field) {
super();
this.field = field;
checkListMapType(field);
}
/**
* get the isList.
*
* @return the isList
*/
public boolean isList() {
return isList;
}
/**
* set isList value to isList.
*
* @param isList the isList to set
*/
public void setList(boolean isList) {
this.isList = isList;
}
/**
* get the isMap.
*
* @return the isMap
*/
public boolean isMap() {
return isMap;
}
/**
* set isMap value to isMap.
*
* @param isMap the isMap to set
*/
public void setMap(boolean isMap) {
this.isMap = isMap;
}
/**
* get the field.
*
* @return the field
*/
public Field getField() {
return field;
}
/**
* get the required.
*
* @return the required
*/
public boolean isRequired() {
return required;
}
/**
* set required value to required.
*
* @param required the required to set
*/
public void setRequired(boolean required) {
this.required = required;
}
/**
* get the order.
*
* @return the order
*/
public int getOrder() {
return order;
}
/**
* set order value to order.
*
* @param order the order to set
*/
public void setOrder(int order) {
this.order = order;
}
/**
* get the fieldType.
*
* @return the fieldType
*/
public FieldType getFieldType() {
return fieldType;
}
/**
* set fieldType value to fieldType.
*
* @param fieldType the fieldType to set
*/
public void setFieldType(FieldType fieldType) {
this.fieldType = fieldType;
}
/**
* get the description.
*
* @return the description
*/
public String getDescription() {
return description;
}
/**
* set description value to description.
*
* @param description the description to set
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Checks for description.
*
* @return true, if successful
*/
public boolean hasDescription() {
if (description == null || description.trim().length() == 0) {
return false;
}
return true;
}
/**
* get the genericKeyType.
*
* @return the genericKeyType
*/
public Class getGenericKeyType() {
return genericKeyType;
}
/**
* set genericKeyType value to genericKeyType.
*
* @param genericKeyType the genericKeyType to set
*/
public void setGenericKeyType(Class genericKeyType) {
this.genericKeyType = genericKeyType;
}
/**
* get the genericeValueType.
*
* @return the genericeValueType
*/
public Class getGenericeValueType() {
return genericeValueType;
}
/**
* set genericeValueType value to genericeValueType.
*
* @param genericeValueType the genericeValueType to set
*/
public void setGenericeValueType(Class genericeValueType) {
this.genericeValueType = genericeValueType;
}
/**
* Checks if is packed.
*
* @return the packed
*/
public boolean isPacked() {
return packed;
}
/**
* Sets the packed.
*
* @param packed the packed to set
*/
public void setPacked(boolean packed) {
this.packed = packed;
}
/**
* Checks if is object type.
*
* @return true, if is object type
*/
public boolean isObjectType() {
return fieldType == FieldType.OBJECT;
}
/**
* Checks if is enum value type.
*
* @return true, if is enum value type
*/
public boolean isEnumValueType() {
if (genericeValueType != null) {
return Enum.class.isAssignableFrom(genericeValueType);
}
return false;
}
/**
* Checks if is enum key type.
*
* @return true, if is enum key type
*/
public boolean isEnumKeyType() {
if (genericKeyType != null) {
return Enum.class.isAssignableFrom(genericKeyType);
}
return false;
}
/**
* Checks if is primitive type.
*
* @param c the c
* @return true, if is primitive type
*/
public static boolean isPrimitiveType(Class c) {
if (c.isPrimitive()) {
return true;
}
if (c.getName().equals(String.class.getName())) {
return true;
}
return false;
}
/**
* Checks if is list type.
*
* @param field the field
* @return true, if is list type
*/
public static boolean isListType(Field field) {
return List.class.isAssignableFrom(field.getType());
}
/**
* Checks if is set type.
*
* @param field the field
* @return true, if is set type
*/
public static boolean isSetType(Field field) {
return Set.class.isAssignableFrom(field.getType());
}
}