SoyJavaRuntimeFunctionUtils.java

/*
 * Copyright 2009 Google Inc.
 *
 * 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 com.google.template.soy.shared.restricted;

import com.google.template.soy.data.SoyData;
import com.google.template.soy.data.restricted.BooleanData;
import com.google.template.soy.data.restricted.FloatData;
import com.google.template.soy.data.restricted.IntegerData;
import com.google.template.soy.data.restricted.StringData;

/**
 * Utilities for implementing {@link SoyJavaRuntimeFunction}s.
 *
 * <p>Important: This class may only be used in implementing plugins (e.g. functions, directives).
 *
 * <p>Feel free to static import these helpers in your function implementation classes.
 *
 * @deprecated Simply use {@code *Data.forValue()} directly.
 */
@Deprecated
public class SoyJavaRuntimeFunctionUtils {

  private SoyJavaRuntimeFunctionUtils() {}

  /**
   * Converts a boolean value to a SoyData (specifically a BooleanData).
   *
   * @param value The boolean value to convert.
   */
  public static SoyData toSoyData(boolean value) {
    return BooleanData.forValue(value);
  }

  /**
   * Converts an int value to a SoyData (specifically an IntegerData).
   *
   * @param value The int value to convert.
   */
  public static SoyData toSoyData(int value) {
    return IntegerData.forValue(value);
  }

  /**
   * Converts a double value to a SoyData (specifically a FloatData).
   *
   * @param value The double value to convert.
   */
  public static SoyData toSoyData(double value) {
    return FloatData.forValue(value);
  }

  /**
   * Converts a String value to a SoyData (specifically a StringData).
   *
   * @param value The String value to convert.
   */
  public static SoyData toSoyData(String value) {
    return StringData.forValue(value);
  }
}