com.prowidesoftware.swift.constraints.CurrencyConstraint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation

Prowide Library for SWIFT messages

There is a newer version: SRU2024-10.2.3

/*
 * Copyright 2006-2023 Prowide
 *
 * 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.prowidesoftware.swift.constraints;

import static java.lang.annotation.ElementType.*;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;

/**
 * Bean validation for ISO currency codes.
 *
 * It will validate true for null, empty or blank values to bypass validation when
 * the field is optional. If you require a currency code to be mandatory, combine this
 * constraint with @NotBlank.
 *
 * @see com.prowidesoftware.swift.utils.IsoUtils#isValidISOCurrency(String) for implementation details
 * @since 7.10.3
 */
@Documented
@Constraint(validatedBy = CurrencyValidator.class)
@Target({METHOD, FIELD, PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface CurrencyConstraint {
    String message() default "{prowide.invalid.currency.code}";

    Class[] groups() default {};

    Class[] payload() default {};
}