/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.tinkerpop.gremlin.process.traversal.util;

import org.apache.tinkerpop.gremlin.process.traversal.TraversalSideEffects;

/**
 * @author Marko A. Rodriguez (http://markorodriguez.com)
 */
public final class SideEffectHelper {

    private SideEffectHelper() {
    }

    public static void validateSideEffectKey(final String key) throws IllegalArgumentException {
        if (null == key)
            throw TraversalSideEffects.Exceptions.sideEffectKeyCanNotBeNull();
        if (key.isEmpty())
            throw TraversalSideEffects.Exceptions.sideEffectKeyCanNotBeEmpty();
    }

    /**
     * @deprecated As of release 3.5.3, not replaced as there is really no general validation anymore for values since
     * {@code null} is now accepted.
     */
    @Deprecated
    public static void validateSideEffectValue(final Object value) throws IllegalArgumentException {
        if (null == value)
            throw TraversalSideEffects.Exceptions.sideEffectValueCanNotBeNull();
    }

    /**
     * @deprecated As of release 3.5.3, not replaced as there is really no general validation anymore for values since
     * {@code null} is now accepted.
     */
    @Deprecated
    public static void validateSideEffectKeyValue(final String key, final Object value) throws IllegalArgumentException {
        SideEffectHelper.validateSideEffectKey(key);
        SideEffectHelper.validateSideEffectValue(value);
    }
}
