org.smooks.cartridges.flatfile.Field Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smooks-flatfile-cartridge Show documentation
The Smooks Flat File Cartridge adds support for reading flat files
The newest version!
/*-
 * ========================LICENSE_START=================================
 * smooks-flatfile-cartridge
 * %%
 * Copyright (C) 2020 Smooks
 * %%
 * Licensed under the terms of the Apache License Version 2.0, or
 * the GNU Lesser General Public License version 3.0 or later.
 *
 * SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later
 *
 * ======================================================================
 *
 * 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.
 *
 * ======================================================================
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * =========================LICENSE_END==================================
 */
package org.smooks.cartridges.flatfile;

import org.smooks.assertion.AssertArgument;

/**
 * Flat file record field.
 *
 * @author [email protected]
 */
public class Field {

    private final String name;
    private final String value;
    private FieldMetaData metaData;

    /**
     * Public constructor.
     *
     * @param name  The field name. Used to create the field value element.
     * @param value The field value.
     */
    public Field(String name, String value) {
        AssertArgument.isNotNullAndNotEmpty(name, "name");
        this.name = name;
        this.value = value;
    }

    /**
     * Get the field name.
     *
     * @return The field name.
     */
    public String getName() {
        return name;
    }

    /**
     * Get the field value.
     *
     * @return The field value.
     */
    public String getValue() {
        return value;
    }

    /**
     * Set optional field metadata.
     *
     * @param metaData The metadata.
     * @return This field instance.
     */
    public Field setMetaData(FieldMetaData metaData) {
        this.metaData = metaData;
        return this;
    }

    /**
     * Get the optional field metadata.
     *
     * @return The metadata, or null if none has been set.
     */
    public FieldMetaData getMetaData() {
        return metaData;
    }
}