com.sun.jersey.spi.StringReaderProvider Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.spi;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
/**
* Contract for a provider that supports the conversion of a string to a
* Java type. To add a StringReaderProvider implementation,
* annotate the implementation class with Provider.
*
* Such providers will be used when converting a String value to a java type
* annotated by the *Param annotations such as {@link javax.ws.rs.QueryParam}.
*
* @param The Java type.
* @see javax.ws.rs.ext.Provider
* @see com.sun.jersey.spi.StringReaderWorkers
* @author [email protected]
*/
public interface StringReaderProvider {
/**
* Obtain a StringReader that can produce an instance of a particular type
* from a string.
*
* @param type the class of object to be produced.
*
* @param genericType the type of object to be produced. E.g. if the
* string is to be converted into a method parameter, this will be
* the formal type of the method parameter as returned by
* Class.getGenericParameterTypes.
*
* @param annotations an array of the annotations on the declaration of the
* artifact that will be initialized with the produced instance. E.g. if the
* string is to be converted into a method parameter, this will be
* the annotations on that parameter returned by
* Class.getParameterAnnotations.
*
* @return the string reader, otherwise null.
*/
StringReader getStringReader(Class type, Type genericType, Annotation annotations[]);
}