com.github.jinahya.kftc.financial.institution.info.KftcFinancialInstitutionInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kftc-financial-institution-info Show documentation
Financial institution information provided by KFTC
The newest version!
package com.github.jinahya.kftc.financial.institution.info;

/*-
 * #%L
 * kftc-financial-institution-info
 * %%
 * Copyright (C) 2024 Jinahya, Inc.
 * %%
 * 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 java.io.Serializable;
import java.util.Objects;

/**
 * Represents an information of a financial institution assigned by KFTC.
 *
 * @author Jin Kwon <onacit_at_gmail.com>
 * @implSpec Instances of this class are unmodifiable and thread-safe.
 * @see KftcFinancialInstitutionInfoSet
 */
public final class KftcFinancialInstitutionInfo
        implements Serializable {

    private static final long serialVersionUID = 5345357074469188526L;

    // ---------------------------------------------------------------------------------------------------- CONSTRUCTORS

    /**
     * Creates a new instance.
     */
    KftcFinancialInstitutionInfo() {
        super();
    }

    // ------------------------------------------------------------------------------------------------ java.lang.Object

    @Override
    public String toString() {
        return super.toString() + '{'
                + "category=" + category
                + ",code=" + code
                + ",name=" + name
                + ",representative=" + representative
                + '}';
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof KftcFinancialInstitutionInfo)) {
            return false;
        }
        final var that = (KftcFinancialInstitutionInfo) obj;
        return Objects.equals(code, that.code);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(code);
    }

    // -------------------------------------------------------------------------------------------------------- category

    /**
     * Returns current value of {@code category} property.
     *
     * @return current value of the {@code category} property.
     */
    public KftcFinancialInstitutionCategory getCategory() {
        return category;
    }

    void setCategory(final KftcFinancialInstitutionCategory category) {
        this.category = category;
    }

    // ------------------------------------------------------------------------------------------------------------ code

    /**
     * Returns current value of {@code code} property.
     *
     * @return current value of the {@code code} property.
     */
    public String getCode() {
        return code;
    }

    void setCode(final String code) {
        this.code = code;
    }

    // ------------------------------------------------------------------------------------------------------------ name

    /**
     * Returns current value of {@code name} property.
     *
     * @return current value of the {@code name} property.
     */
    public String getName() {
        return name;
    }

    void setName(final String name) {
        this.name = name;
    }

    // -------------------------------------------------------------------------------------------------- representative

    /**
     * Returns current value of {@code representative} property.
     *
     * @return current value of the {@code representative} property.
     */
    public boolean isRepresentative() {
        return representative;
    }

    void setRepresentative(final boolean representative) {
        this.representative = representative;
    }

    // -----------------------------------------------------------------------------------------------------------------
    private KftcFinancialInstitutionCategory category;

    private String code;

    private String name;

    private boolean representative;
}