com.vectorprint.configuration.binding.parameters.ParamBindingHelper Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 VectorPrint.
 *
 * 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.vectorprint.configuration.binding.parameters;

/*
 * #%L
 * Config
 * %%
 * Copyright (C) 2015 VectorPrint
 * %%
 * 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.
 * #L%
 */

import com.vectorprint.configuration.binding.BindingHelper;
import com.vectorprint.configuration.parameters.Parameter;
import java.io.Serializable;

/**
 *
 * @author Eduard Drenth at VectorPrint.nl
 */
public interface ParamBindingHelper extends BindingHelper {

   /**
    * call this from {@link ParameterizableSerializer} to give applications a chance to manipulate values before
    * serialization.
    *
    * @param 
    * @param p
    * @param useDefault when true call {@link Parameter#getDefault() }, otherwise {@link Parameter#getValue() } 
    * @return
    */
    TYPE getValueToSerialize(Parameter p, boolean useDefault);

   /**
    *
    * Call this from {@link ParameterizableParser#initParameter(com.vectorprint.configuration.parameters.Parameter, java.lang.Object)
    * } and when a default is found to give applications a chance to manipulate values before setting it in a Parameter.
    *
    * @param 
    * @param parameter
    * @param value
    * @param setDefault
    */
    void setValueOrDefault(Parameter parameter, TYPE value, boolean setDefault);

}