EnumFormatter.java

/*

 * Copyright 2004 the original author or authors.

 *

 * 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.ancientprogramming.fixedformat4j.format.impl;

import com.ancientprogramming.fixedformat4j.annotation.EnumFormat;

import com.ancientprogramming.fixedformat4j.exception.FixedFormatException;

import com.ancientprogramming.fixedformat4j.format.AbstractFixedFormatter;

import com.ancientprogramming.fixedformat4j.format.FormatContext;

import com.ancientprogramming.fixedformat4j.format.FormatInstructions;

import com.ancientprogramming.fixedformat4j.format.data.FixedFormatEnumData;

/**

 * Formatter for Java enum types.

 *

 * <p>Supports two serialization modes controlled by {@code @FixedFormatEnum}:

 * <ul>

 *   <li>{@link EnumFormat#LITERAL} (default) — uses {@link Enum#name()} / {@link Enum#valueOf}</li>

 *   <li>{@link EnumFormat#NUMERIC} — uses {@link Enum#ordinal()} / index lookup</li>

 * </ul>

 *

 * <p>Padding is handled by the {@link AbstractFixedFormatter} base class using the field's

 * configured {@code paddingChar} and {@code align}. This formatter receives a padding-stripped

 * value in {@link #asObject} and must not apply additional whitespace-specific trimming,

 * so non-space padding characters (e.g. {@code '*'}, {@code '0'}) are handled correctly.

 *

 * @author Jacob von Eyben - <a href="https://eybenconsult.com">https://eybenconsult.com</a>

 * @since 1.7.0

 */

public class EnumFormatter extends AbstractFixedFormatter<Enum> {

  private final FormatContext<?> context;

  /**

   * Creates an {@code EnumFormatter} bound to the given format context.

   * The context's data type must be an enum class.

   *

   * @param context the format context describing the field's data type

   */

  public EnumFormatter(FormatContext<?> context) {

    this.context = context;

  }

  /**

   * {@inheritDoc}

   *

   * <p>The {@code value} received here has already had its padding stripped by

   * {@link AbstractFixedFormatter#parse} using the field's actual {@code paddingChar},

   * so no additional trimming is performed.

   */

  @SuppressWarnings({"unchecked", "rawtypes"})

  @Override

  public Enum asObject(String value, FormatInstructions instructions) {

    if (value == null || value.isEmpty()) {

      return null;

    }

    Class<? extends Enum> enumClass = (Class<? extends Enum>) context.getDataType();

    EnumFormat format = enumFormat(instructions);

    if (format == EnumFormat.NUMERIC) {

      int ordinal;

      try {

        ordinal = Integer.parseInt(value);

      } catch (NumberFormatException e) {

        throw new FixedFormatException(

            String.format("Cannot parse ordinal for enum [%s] from value [%s]", enumClass.getName(), value), e);

      }

      Enum<?>[] constants = enumClass.getEnumConstants();

      if (ordinal < 0 || ordinal >= constants.length) {

        throw new FixedFormatException(

            String.format("Ordinal [%d] is out of range for enum [%s] (valid range: 0..%d)", ordinal, enumClass.getName(), constants.length - 1));

      }

      return constants[ordinal];

    } else {

      try {

        return Enum.valueOf(enumClass, value);

      } catch (IllegalArgumentException e) {

        throw new FixedFormatException(

            String.format("Cannot find enum constant [%s] in [%s]", value, enumClass.getName()), e);

      }

    }

  }

  /** {@inheritDoc} */

  @Override

  public String asString(Enum value, FormatInstructions instructions) {

    if (value == null) {

      return "";

    }

    return enumFormat(instructions) == EnumFormat.NUMERIC

        ? String.valueOf(value.ordinal())

        : value.name();

  }

  private EnumFormat enumFormat(FormatInstructions instructions) {

    FixedFormatEnumData data = instructions.getFixedFormatEnumData();

    return (data != null) ? data.getEnumFormat() : EnumFormat.LITERAL;

  }

}

Active mutators

• CONDITIONALS_BOUNDARY
• CONSTRUCTOR_CALLS
• EMPTY_RETURNS
• EXPERIMENTAL_ARGUMENT_PROPAGATION
• EXPERIMENTAL_BIG_DECIMAL
• EXPERIMENTAL_BIG_INTEGER
• EXPERIMENTAL_MEMBER_VARIABLE
• EXPERIMENTAL_NAKED_RECEIVER
• EXPERIMENTAL_REMOVE_SWITCH_MUTATOR_[0-99]
• EXPERIMENTAL_SWITCH
• FALSE_RETURNS
• INCREMENTS
• INLINE_CONSTS
• INVERT_NEGS
• MATH
• NEGATE_CONDITIONALS
• NON_VOID_METHOD_CALLS
• NULL_RETURNS
• PRIMITIVE_RETURNS
• REMOVE_CONDITIONALS_EQUAL_ELSE
• REMOVE_CONDITIONALS_EQUAL_IF
• REMOVE_CONDITIONALS_ORDER_ELSE
• REMOVE_CONDITIONALS_ORDER_IF
• REMOVE_INCREMENTS
• TRUE_RETURNS
• VOID_METHOD_CALLS

Tests examined

• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nullEnumData_defaultsToLiteralBehavior_format()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalFormat_blueProducesBlueString()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericFormat_blueIsOrdinalTwo()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericFormat_redIsOrdinalZero()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalFormat_greenProducesGreenString()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericFormat_greenIsOrdinalOne()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalFormat_redProducesRedString()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalAndNumericProduceDistinctOutput()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalRoundTrip_allConstants()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericRoundTrip_allConstants()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter]/[method:testDispatchesToEnumFormatter_format()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:exportLiteralDefaultNoAnnotation()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_rightAlign_export()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:exportNumeric()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:literalRoundTrip()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:numericRoundTrip()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_leftAlign_roundTrip_active()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:zeroPadding_numeric_rightAlign_roundTrip_high()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_leftAlign_roundTrip_inactive()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_leftAlign_export()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:zeroPadding_numeric_rightAlign_export_high()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_rightAlign_roundTrip_pending()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:twoFieldRecordRoundTrip()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nonNumericOrdinal_throwsFixedFormatException()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nonNumericOrdinal_exceptionMessageMentionsCannotParseOrdinal()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:invalidOrdinalNonNumericThrowsOnParse()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:outOfRangeOrdinal_positive_throwsFixedFormatException()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:outOfRangeOrdinal_negative_exceptionMessageMentionsOutOfRange()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:outOfRangeOrdinal_positive_exceptionMessageMentionsOutOfRange()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:invalidOrdinal_throwsFixedFormatException()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:invalidOrdinalThrowsOnParse()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:rightAlignedNumericParse_stripsLeadingSpaces()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericParse_ordinalTwoIsBlue()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericParse_ordinalOneIsGreen()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:numericParse_ordinalZeroIsRed()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:zeroPadding_numeric_rightAlign_load_high()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:loadNumeric()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:zeroPadding_numeric_rightAlign_load_medium()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nullEnumData_defaultsToLiteralBehavior_parse()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:unknownLiteralName_exceptionMessageContainsBadValue()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:rightAlignedLiteralParse_stripsLeadingSpaces()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalParse_returnsRedConstant()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalParse_returnsBlueConstant()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:unknownLiteralName_throwsFixedFormatException()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:unknownLiteralName_exceptionMessageContainsEnumClassName()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:literalParse_returnsGreenConstant()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter]/[method:testDispatchesToEnumFormatter_parse()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_rightAlign_load()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:loadLiteralDefaultNoAnnotation()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:starPadding_leftAlign_load()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:loadLiteralExplicitAnnotation()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:invalidLiteralNameThrowsOnParse()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestFixedFormatManagerImplErrors.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestFixedFormatManagerImplErrors]/[method:enumField_literalFitsExactly_doesNotThrow()] (3 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:allPaddingInput_literal_parsesToNull()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:allPaddingInput_numeric_parsesToNull()] (0 ms)
• com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.issues.TestIssue67EnumSupport]/[method:nullEnumFieldRoundTrip()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nullValue_literal_formatsToAllPadding()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestEnumFormatter]/[method:nullValue_numeric_formatsToAllPadding()] (0 ms)
• com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter.[engine:junit-jupiter]/[class:com.ancientprogramming.fixedformat4j.format.impl.TestByTypeFormatter]/[method:testEnumTypeRoutesToEnumFormatter()] (0 ms)