com.feilong.json.builder.ArrayExcludePropertyNamesPropertyFilter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * 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.feilong.json.builder;

import com.feilong.lib.json.util.PropertyFilter;

/**
 * 排除属性过滤器, {@code json ---> java} 的时候,想排除某个属性.
 * 
 * 
 * 比如 taobao 接口返回的数据, 有老的废弃属性 county (可能早期由于单词写错了. 为了兼容老代码)
 * 
 * 
 *  * {@code
 * {
 *             "country": "中国",
 *             "country_id": "CN",
 *             "area": "华北",
 *             "area_id": "100000",
 *             "region": "北京市",
 *             "region_id": "110000",
 *             "city": "北京市",
 *             "city_id": "110100",
 *             "county": "",
 *             "county_id": "-1",
 *             "isp": "科技网",
 *             "isp_id": "1000114",
 *             "ip": "210.75.225.254"
 *         }
 * }
 * 
 * 
 * 
 * 但是我们的java bean 没有这个属性
 * 
 * 导致转换的时候, 由于 使用了 PropertyStrategyWrapper
 * 
 *  * {@code
 *   public void setProperty(Object bean,String key,Object value){
 *         try{
 *             propertySetStrategy.setProperty(bean, key, value);
 *         }catch (Exception e){
 *             LOGGER.warn(e.getMessage(), e);
 *         }
 *     }
 * }
 * 
 * 
 * 会提示 warn 级别的日志, 很烦人
 * 
 *  * {@code
 * 
 * 20:33:38 WARN  (PropertyStrategyWrapper.java:69) [setProperty()] java.lang.NoSuchMethodException: Unknown property 'county' on class 'class com.feilong.tools.IpInfoEntity'
 * net.sf.json.JSONException: java.lang.NoSuchMethodException: Unknown property 'county' on class 'class com.feilong.tools.IpInfoEntity'
 *     at net.sf.json.util.PropertySetStrategy$DefaultPropertySetStrategy._setProperty(PropertySetStrategy.java:69)
 *     at net.sf.json.util.PropertySetStrategy$DefaultPropertySetStrategy.setProperty(PropertySetStrategy.java:60)
 *     at net.sf.json.util.PropertySetStrategy$DefaultPropertySetStrategy.setProperty(PropertySetStrategy.java:45)
 *     at com.feilong.json.jsonlib.PropertyStrategyWrapper.setProperty(PropertyStrategyWrapper.java:67)
 *     at net.sf.json.util.PropertySetStrategy.setProperty(PropertySetStrategy.java:40)
 *     at net.sf.json.JSONObject.setProperty(JSONObject.java:1394)
 *     at net.sf.json.JSONObject.toBean(JSONObject.java:429)
 *     at com.feilong.json.JsonUtil.toBean(JsonUtil.java:1275)
 *     at com.feilong.tools.IpUtil.toIpInfoEntity(IpUtil.java:162)
 *     at com.feilong.tools.IpUtil.getIpInfoEntity(IpUtil.java:138)
 * Caused by: java.lang.NoSuchMethodException: Unknown property 'county' on class 'class com.feilong.tools.IpInfoEntity'
 *     at org.apache.commons.beanutils.PropertyUtilsBean.setSimpleProperty(PropertyUtilsBean.java:2091)
 *     at org.apache.commons.beanutils.PropertyUtils.setSimpleProperty(PropertyUtils.java:928)
 *     at net.sf.json.util.PropertySetStrategy$DefaultPropertySetStrategy._setProperty(PropertySetStrategy.java:67)
 *     ... 33 more
 * }
 * 
 *
 * @author feilong
 * @see json 转java 的时候,想排除某个属性
 * @since 1.11.0
 */
class ArrayExcludePropertyNamesPropertyFilter implements PropertyFilter{

    /** The property names. */
    private final String[] propertyNames;

    //---------------------------------------------------------------

    /**
     * The Constructor.
     *
     * @param propertyNames
     *            the property names
     */
    public ArrayExcludePropertyNamesPropertyFilter(String...propertyNames){
        this.propertyNames = propertyNames;
    }

    //---------------------------------------------------------------

    /*
     * (non-Javadoc)
     * 
     * @see net.sf.json.util.PropertyFilter#apply(java.lang.Object, java.lang.String, java.lang.Object)
     */
    @Override
    public boolean apply(Object source,String name,Object value){
        // [source] the owner of the property
        // [name] the name of the property
        // [value] the value of the property
        return com.feilong.lib.lang3.ArrayUtils.contains(propertyNames, name);
    }
}