SoyPrintDirective.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 java.util.Set;

/**
 * Superinterface for a Soy print directive.
 *
 * <p>Important: Implementing this interface by itself does nothing. Your directive implementation
 * class needs to implement some of all of this interface's subinterfaces.
 *
 */
public interface SoyPrintDirective {

  /**
   * Gets the name of the Soy print directive.
   *
   * @return The name of the Soy print directive.
   */
  public String getName();

  /**
   * Gets the set of valid args list sizes. For example, the set {0, 2} would indicate that this
   * directive can take 0 or 2 arguments (but not 1).
   *
   * @return The set of valid args list sizes.
   */
  public Set<Integer> getValidArgsSizes();

  /**
   * Returns whether the appearance of this directive on a 'print' tag should cancel autoescape for
   * that 'print' tag.
   *
   * @return Whether the appearance of this directive on a 'print' tag should cancel autoescape for
   *     that 'print' tag.
   */
  public boolean shouldCancelAutoescape();
}