uk.gov.gchq.gaffer.named.operation.GetAllNamedOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of operation Show documentation

There is a newer version: 2.3.1

/*
 * Copyright 2016-2020 Crown Copyright
 *
 * 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 uk.gov.gchq.gaffer.named.operation;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.type.TypeReference;

import uk.gov.gchq.gaffer.named.operation.serialisation.NamedOperationTypeReference;
import uk.gov.gchq.gaffer.operation.io.Output;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;

import java.util.Map;

/**
 * A {@link GetAllNamedOperations} is an {@link uk.gov.gchq.gaffer.operation.Operation}
 * for retrieving all {@link NamedOperation}s associated with a Gaffer graph.
 */
@JsonPropertyOrder(value = {"class"}, alphabetic = true)
@Since("1.0.0")
@Summary("Gets all available named operations")
public class GetAllNamedOperations implements
        Output> {
    private Map options;

    @Override
    public TypeReference> getOutputTypeReference() {
        return new NamedOperationTypeReference.IterableNamedOperationDetail();
    }

    @Override
    public GetAllNamedOperations shallowClone() {
        return new GetAllNamedOperations.Builder()
                .options(options)
                .build();
    }

    @Override
    public Map getOptions() {
        return options;
    }

    @Override
    public void setOptions(final Map options) {
        this.options = options;
    }

    public static class Builder extends BaseBuilder
            implements Output.Builder, Builder> {
        public Builder() {
            super(new GetAllNamedOperations());
        }
    }
}