com.igormaznitsa.jcp.expression.functions.FunctionSTR2JS Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
 *
 * 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 com.igormaznitsa.jcp.expression.functions;

import static org.apache.commons.text.StringEscapeUtils.escapeEcmaScript;


import com.igormaznitsa.jcp.context.PreprocessorContext;
import com.igormaznitsa.jcp.expression.Value;
import com.igormaznitsa.jcp.expression.ValueType;

/**
 * The class implements the str2js function handler
 *
 * @author Igor Maznitsa ([email protected])
 */
public final class FunctionSTR2JS extends AbstractStrConverter {

  @Override

  public String getName() {
    return "str2js";
  }

  @Override

  public Value executeStr(final PreprocessorContext context, final Value value) {
    final String escaped = escapeEcmaScript(value.asString());
    return Value.valueOf(escaped);
  }

  @Override

  public String getReference() {
    return "escape string for EcmaScript/JavaScript";
  }

  @Override

  public ValueType getResultType() {
    return ValueType.STRING;
  }
}