org.deltafi.actionkit.action.ContentInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deltafi-action-kit Show documentation

DeltaFi Action Kit - Action implementation SDK for DeltaFi actions

There is a newer version: 2.0-rc2

/*
 *    DeltaFi - Data transformation and enrichment platform
 *
 *    Copyright 2021-2023 DeltaFi Contributors 
 *
 *    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 org.deltafi.actionkit.action;

import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.SuperBuilder;
import org.deltafi.actionkit.action.content.ActionContent;
import org.jetbrains.annotations.NotNull;

import java.util.ArrayList;
import java.util.List;

/**
 * Action input that may include content or metadata
 */
@Data
@EqualsAndHashCode(callSuper = true)
@SuperBuilder
public class ContentInput extends MetadataInput {
    @Builder.Default
    protected List content = new ArrayList<>();

    public List content() {
        return content;
    }

    /**
     * @deprecated Use {@link #content()} instead.
     */
    @Deprecated
    public List getContentList() {
        return content;
    }

    public void setContent(@NotNull List content) {
        this.content = content;
    }

    /**
     * @deprecated Use {@link #setContent(List)} instead.
     */
    @Deprecated
    public void setContentList(@NotNull List contentList) {
        this.content = contentList;
    }

    /**
     * Checks if the content list is not empty.
     * @return {@code true} if the content list is not empty, {@code false} otherwise.
     */
    public boolean hasContent() {
        return !content.isEmpty();
    }

    /**
     * Gets the content at the specified index.
     * @param index The index of the content
     * @return The first action content
     * @throws ActionKitException If no content is found in the input.
     */
    public ActionContent content(int index) {
        if (content.size() <= index) {
            throw new ActionKitException("Requested content at index " + index + ", but only " + content.size() + " are available.");
        }

        return content.get(index);
    }
}