org.apache.commons.validator.routines.checkdigit.VATidELCheckDigit Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isoiec7064 Show documentation
A Java library to calculate and validate ISO/IEC 7064 System check digits.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.validator.routines.checkdigit;

import org.apache.commons.validator.GenericTypeValidator;
import org.apache.commons.validator.GenericValidator;

/**
 * Greek VAT identification number (VATIN) Check Digit calculation/validation.
 * 
 * Arithmos Forologikou Mitroou FPA
 * 
 * 
 * See Wikipedia
 * for more details.
 * 
 *
 * @since 1.10.0
 */
public final class VATidELCheckDigit extends IsoIecPure11System {

    private static final long serialVersionUID = -1693031762197317534L;

    /** Singleton Check Digit instance */
    private static final VATidELCheckDigit INSTANCE = new VATidELCheckDigit();

    /**
     * Gets the singleton instance of this validator.
     * @return A singleton instance of the class.
     */
    public static CheckDigit getInstance() {
        return INSTANCE;
    }

    @Override
    protected String getCharacterSet() {
        return NUMERIC;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String calculate(final String code) throws CheckDigitException {
        if (GenericValidator.isBlankOrNull(code)) {
            throw new CheckDigitException(CheckDigitException.MISSING_CODE);
        }
        Long l = GenericTypeValidator.formatLong(code);
        if (l == null) {
            throw new CheckDigitException(CheckDigitException.invalidCode(code));
        }
        if (l == 0) {
            throw new CheckDigitException(CheckDigitException.ZERO_SUM);
        }
        final int cm = INSTANCE.calculateModulus(code, false);
        return toCheckDigit(cm > 9 ? 0 : cm);  // CHECKSTYLE IGNORE MagicNumber
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isValid(final String code) {
        if (GenericValidator.isBlankOrNull(code)) {
            return false;
        }
        Long l = GenericTypeValidator.formatLong(code);
        if (l == null || l == 0) {
            return false;
        }
        try {
            int cm = INSTANCE.calculateModulus(code, true);
            if (cm > 9) {  // CHECKSTYLE IGNORE MagicNumber
                cm = 0;
            }
            return cm == Character.getNumericValue(code.charAt(code.length() - 1));
        } catch (final CheckDigitException ex) {
            return false;
        }
    }

}