org.dominokit.jacksonapt.deser.EnumJsonDeserializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jackson-apt Show documentation
Apt based jackson
The newest version!
/*
 * Copyright 2013 Nicolas Morel
 *
 * 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 org.dominokit.jacksonapt.deser;

import org.dominokit.jacksonapt.JsonDeserializationContext;
import org.dominokit.jacksonapt.JsonDeserializer;
import org.dominokit.jacksonapt.JsonDeserializerParameters;
import org.dominokit.jacksonapt.stream.JsonReader;

/**
 * Default {@link org.dominokit.jacksonapt.JsonDeserializer} implementation for {@link
 * java.lang.Enum}.
 *
 * @param  Type of the enum
 */
public class EnumJsonDeserializer> extends JsonDeserializer {

  /**
   * newInstance
   *
   * @param enumClass class of the enumeration
   * @param values {@link E[]}
   * @param  the enum type
   * @return a new instance of {@link org.dominokit.jacksonapt.deser.EnumJsonDeserializer}
   */
  public static > EnumJsonDeserializer newInstance(
      Class enumClass, E[] values) {
    return new EnumJsonDeserializer(enumClass, values);
  }

  private final Class enumClass;
  private final E[] values;

  /**
   * Constructor for EnumJsonDeserializer.
   *
   * @param enumClass class of the enumeration
   * @param values {@link E[]} enum values
   */
  protected EnumJsonDeserializer(Class enumClass, E[] values) {
    if (null == enumClass) {
      throw new IllegalArgumentException("enumClass cannot be null");
    }
    this.enumClass = enumClass;
    this.values = values;
  }

  /** {@inheritDoc} */
  @Override
  public E doDeserialize(
      JsonReader reader, JsonDeserializationContext ctx, JsonDeserializerParameters params) {
    try {
      return getEnum(values, reader.nextString());
    } catch (IllegalArgumentException ex) {
      if (ctx.isReadUnknownEnumValuesAsNull()) {
        return null;
      }
      throw ex;
    }
  }

  public > E getEnum(E[] values, String name) {
    for (int i = 0; i < values.length; i++) {
      if (values[i].name().equals(name)) {
        return values[i];
      }
    }
    throw new IllegalArgumentException(
        "[" + name + "] is not a valid enum constant for Enum type " + getEnumClass().getName());
  }

  /**
   * Getter for the field enumClass.
   *
   * @return a {@link java.lang.Class} object.
   */
  public Class getEnumClass() {
    return enumClass;
  }
}