uk.gov.gchq.gaffer.operation.function.ToEntityId 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 2018-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.operation.function;

import uk.gov.gchq.gaffer.data.element.id.EntityId;
import uk.gov.gchq.gaffer.operation.data.EntitySeed;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import uk.gov.gchq.koryphe.function.KorypheFunction;


/**
 * A {@code ToEntityId} converts an {@link EntityId} or vertex into an {@link EntityId}.
 * If the input is not an {@link EntityId} then it is wrapped in an {@link EntitySeed}.
 * If the input is already an {@link EntityId} is not modified.
 */
@Since("1.3.0")
@Summary("Converts an object to an EntityId")
public class ToEntityId extends KorypheFunction {
    @Override
    public EntityId apply(final Object obj) {
        if (null == obj) {
            return null;
        }
        return obj instanceof EntityId ? (EntityId) obj : new EntitySeed(obj);
    }
}