com.helger.html.js.tostring.IJSToStringConverter Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.html.js.tostring;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;

/**
 * Interface that defines the conversion routines to convert an arbitrary Java
 * object to a valid JavaScript object.
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IJSToStringConverter
{
  /**
   * Convert an arbitrary JS object to a string.
   *
   * @param aObject
   *        The object to be converted. May be null.
   * @param aType
   *        The JS type to use. May not be null.
   * @return null if the passed object is null.
   */
  @Nullable
  String objectToJSString (@Nullable Object aObject, @Nonnull JSType aType);
}