sviolet.slate.common.x.conversion.mapxbean.BeanToMapInflateStrategy Maven / Gradle / Ivy
Show all versions of slate-mapxbean Show documentation
/*
* Copyright (C) 2015-2020 S.Violet
*
* 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.
*
* Project GitHub: https://github.com/shepherdviolet/slate
* Email: [email protected]
*/
package sviolet.slate.common.x.conversion.mapxbean;
import sviolet.slate.common.x.conversion.mapxbean.strategy.InflateCollectionElements;
import sviolet.slate.common.x.conversion.mapxbean.strategy.InflateUntilIndivisible;
/**
* [Inflate Strategy] [For Bean -> Map] Decide whether to continue inflating property (it's a Java Bean) to Map
*
* NOTE that the property must be a Java Bean, because the program has already determined whether it is a JavaBean
* before calling this interface. (Judged by built-in component {@link MxbTypeJudger#isBean})
*
* References:
*
* In the scene of Bean -> Map. While a Bean is converting to a Map, all the properties of Bean will keep the
* original type by default, unless {@link BeanToMapInflateStrategy} tells the program that it needs to be inflated
* (this method returns true).
* 'Inflate' means that in the scene of Bean -> Map, if a property (of Java Bean) or an element (of Collection) is
* a Java Bean (judged by {@link MxbTypeJudger#isBean}), the property (or element) can be converted to a Map as long
* as the method {@link BeanToMapInflateStrategy#needToBeInflated} returns true. The process of converting property
* (or element) to Map is called 'Inflate'.
*
* @author S.Violet
* @see MapXBean
* @see BeanToMapConverterImpl
* @see InflateUntilIndivisible
* @see InflateCollectionElements
*/
public interface BeanToMapInflateStrategy {
/**
* Decide whether to continue inflating property (it's a Java Bean) to Map
*
* NOTE that the property must be a Java Bean, because the program has already determined whether it is a JavaBean
* before calling this method. (Judged by built-in component {@link MxbTypeJudger#isBean})
*
* References:
*
* In the scene of Bean -> Map. While a Bean is converting to a Map, all the properties of Bean will keep the
* original type by default, unless {@link BeanToMapInflateStrategy} tells the program that it needs to be inflated
* (this method returns true).
* 'Inflate' means that in the scene of Bean -> Map, if a property (of Java Bean) or an element (of Collection) is
* a Java Bean (judged by {@link MxbTypeJudger#isBean}), the property (or element) can be converted to a Map as long
* as this method returns true. The process of converting property (or element) to Map is called 'Inflate'.
*
* @param bean Decide whether to continue inflating this Bean to Map
* @param beanClass The type of the Bean
* @param typeJudger Built-in type judger. To determine what type a class is. Although the program has called
* MxbTypeJudger#isBean before calling this method.
* @param conversionPath It represents the conversion path when the exception is thrown, Nullable
* @return true: Inflate the property (Bean) to a Map, false: Keep raw type
*/
boolean needToBeInflated(Object bean,
Class beanClass,
MxbTypeJudger typeJudger,
ConversionPath conversionPath);
}