com.google.gwt.dev.util.xml.AttributeConverter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2006 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.gwt.dev.util.xml;

import com.google.gwt.core.ext.UnableToCompleteException;

/**
 * Converts from a string to the type needed.
 */
public abstract class AttributeConverter {
  /**
   * Converts from a string to the type needed.
   * Does not throw conversion-related exceptions.
   * @param value
   *    the value to convert
   * @param schema
   *    used to report conversion problems
   * @return
   *    the argument converted to a form that is expected to compatible with
   *    the associated parameter and will work for a reflection "invoke()" call;
   *    null if the conversion failed.
   */
  public abstract Object convertToArg(Schema schema, int line,
      String elem, String attr, String value) throws UnableToCompleteException;
}