/*
 * 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.types.function;

import uk.gov.gchq.gaffer.types.TypeValue;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import uk.gov.gchq.koryphe.function.KorypheFunction;

/**
 * A {@code ToTypeValue} is a {@link KorypheFunction} that converts a
 * value into a {@link TypeValue}, by setting the Type to null (or the provided string)
 * and the Value to the input value.
 */
@Since("1.8.0")
@Summary("Converts a value into a TypeValue")
public class ToTypeValue extends KorypheFunction<Object, TypeValue> {
    private String type;

    public ToTypeValue(final String type) {
        setType(type);
    }

    public ToTypeValue() {
        this(null);
    }

    @Override
    public TypeValue apply(final Object value) {
        return new TypeValue(type, null != value ? value.toString() : null);
    }

    public String getType() {
        return type;
    }

    public void setType(final String type) {
        this.type = type;
    }
}
