io.knotx.knot.action.domain.FormSimplifier Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 Cognifide Limited
 *
 * 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 io.knotx.knot.action.domain;

@FunctionalInterface
public interface FormSimplifier {

  /**
   * Removes all Knot.x specific tags from form fragment (form definition).
   * Additionally it adds hidden input field with from identifier.
   *
   * @param content - content of a fragment that should be processed.
   * @param formIdAttrName - unique identifier of a hidden form field.
   * @param formIdAttrValue - value of identifier hidden field.
   * @return processed content.
   */
  String simplify(String content, String formIdAttrName, String formIdAttrValue);

}