• Home
• com.vectorprint
• Config
• 8.3
• source code
• BindingHelper.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.vectorprint.configuration.binding.BindingHelper Maven / Gradle / Ivy

/*
 * 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;

/*
 * #%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.VectorPrintRuntimeException;
import java.awt.Color;
import java.io.File;
import java.lang.reflect.Field;
import java.net.MalformedURLException;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.regex.Pattern;

/**
 * Responsible for converting Strings into (atomic) values and vise versa.
 *
 * BindingHelpers are Threadsafe.
 *
 * @author Eduard Drenth at VectorPrint.nl
 */
public interface BindingHelper {

   /**
    * use this from {@link #serializeValue(java.lang.Object) } if you need to escape syntax specific characters. Note
    * that overriding only this method when extending {@link AbstractBindingHelperDecorator} will not work, because the
    * overridden method will not be called by the encapsulated {@link BindingHelper}.
    *
    * @see #setEscapeChars(char[])
    * @param value
    * @return
    */
   public String escape(String value);

   /**
    * set characters to be escaped, do this from the constructors when extending {@link AbstractBindingHelperDecorator}.
    *
    * @param chars
    */
   public void setEscapeChars(char[] chars);

   /**
    * supports arrays of primitives and their wrappers, enums, URL, Color, Date, Pattern and String
    *
    * @param 
    * @param values
    * @param clazz
    * @return
    */
    T convert(String[] values, Class clazz);

   /**
    * supports primitives and their wrappers, enums, URL, Color, Date, Pattern and String
    *
    * @param 
    * @param value
    * @param clazz
    * @return
    */
    T convert(String value, Class clazz);

   /**
    * set separator to be used for array values, do this from the constructors when extending
    * {@link AbstractBindingHelperDecorator}.
    *
    * @param separator
    * @param char
    */
   public void setArrayValueSeparator(char separator);

   char getArrayValueSeparator();

   /**
    * Serialize Objects and arrays of Objects and primitives in a specific syntax. Array values will be separated by the
    * {@link #setArrayValueSeparator(char) separator}.
    *
    * @param value
    * @return the String
    */
   String serializeValue(Object value);

   public static class FloatParser implements StringConverter {

      @Override
      public Float convert(String val) {
         return Float.valueOf(val);
      }
   }

   public static class LongParser implements StringConverter {

      @Override
      public Long convert(String val) {
         return Long.valueOf(val);
      }
   }

   public static class DoubleParser implements StringConverter {

      @Override
      public Double convert(String val) {
         return Double.valueOf(val);
      }
   }

   public static class BooleanParser implements StringConverter {

      @Override
      public Boolean convert(String val) {
         return Boolean.valueOf(val);
      }
   }

   public static class ColorParser implements StringConverter {

      @Override
      public Color convert(String value) {
         if (value.indexOf('#') == 0) {
            return Color.decode(value);
         } else {
            Field f = null;
            try {
               // assume name
               f = Color.class.getField(value);
            } catch (NoSuchFieldException | SecurityException ex) {
               throw new VectorPrintRuntimeException(ex);
            }
            try {
               return (Color) f.get(null);
            } catch (IllegalArgumentException | IllegalAccessException ex) {
               throw new VectorPrintRuntimeException(ex);
            }
         }
      }
   }

   /**
    * tries to construct a URL from a String. When a MalformedURLException is thrown and a File exists the URL is
    * created via new File.
    */
   public static class URLParser implements StringConverter {

      @Override
      public URL convert(String val) {
         try {
            return new URL(val);
         } catch (MalformedURLException ex) {
            File file = new File(val);
            if (file.exists()) {
               try {
                  return file.toURI().toURL();
               } catch (MalformedURLException ex1) {
                  throw new VectorPrintRuntimeException(ex);
               }
            }
            throw new VectorPrintRuntimeException("file " + val + " does not exist, unable to construct url",ex);
         }
      }
   }

   /**
    * Constructs a File from a String.
    */
   public static class FileParser implements StringConverter {

      @Override
      public File convert(String val) {
         return new File(val);
      }
   }

   public static class ClassParser implements StringConverter {

      @Override
      public Class convert(String val) {
         try {
            return Class.forName(val);
         } catch (ClassNotFoundException ex) {
            throw new VectorPrintRuntimeException(ex);
         }
      }

   }

   public static class IntParser implements StringConverter {

      @Override
      public Integer convert(String val) {
         return Integer.valueOf(val);
      }
   }

   public static class CharParser implements StringConverter {

      @Override
      public Character convert(String val) {
         if (val == null || val.length() == 0) {
            return null;
         } else if (val.length() > 1) {
            throw new VectorPrintRuntimeException(String.format("cannot turn %s into one Character", val));
         }
         return val.charAt(0);
      }
   }

   public static class ShortParser implements StringConverter {

      @Override
      public Short convert(String val) {
         return Short.valueOf(val);
      }
   }

   public static class ByteParser implements StringConverter {

      @Override
      public Byte convert(String val) {
         return Byte.decode(val);
      }
   }

   public static class DateParser implements StringConverter {

      @Override
      public Date convert(String val) {
         try {
            return new SimpleDateFormat().parse(val);
         } catch (java.text.ParseException ex) {
            throw new VectorPrintRuntimeException(ex);
         }
      }
   }

   public static class RegexParser implements StringConverter {

      @Override
      public Pattern convert(String val) {
         return Pattern.compile(val);
      }
   }
   public static final IntParser INT_PARSER = new IntParser();
   public static final CharParser CHAR_PARSER = new CharParser();
   public static final ShortParser SHORT_PARSER = new ShortParser();
   public static final ByteParser BYTE_PARSER = new ByteParser();
   public static final LongParser LONG_PARSER = new LongParser();
   public static final FloatParser FLOAT_PARSER = new FloatParser();
   public static final DoubleParser DOUBLE_PARSER = new DoubleParser();
   public static final URLParser URL_PARSER = new URLParser();
   public static final FileParser FILE_PARSER = new FileParser();
   public static final ClassParser CLASS_PARSER = new ClassParser();
   public static final BooleanParser BOOLEAN_PARSER = new BooleanParser();
   public static final ColorParser COLOR_PARSER = new ColorParser();
   public static final DateParser DATE_PARSER = new DateParser();
   public static final RegexParser REGEX_PARSER = new RegexParser();
}