com.sun.jersey.spi.StringReader 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.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Read a string value and convert to a Java type.
*
* A {@link StringReaderProvider} is responsible for providing an instance
* of this interface.
*
* If annotated with {@link ValidateDefaultValue} with a value of true or
* the annotation is absent then the reader will be used to validate a default
* value (if any) by calling the fromString method, perhaps at initialization,
* before any value, default or otherwise, is actually required. This
* enables the early reporting of errors for default values.
* If annotated with {@link ValidateDefaultValue} with a value of false then
* the reader will not be used to validate a default (if any) before any value,
* default or otherwise, is actually required.
*
* @param the Java type to convert to.
*
* @author [email protected]
*/
public interface StringReader {
/**
* Declares whether validation of a default value should occur before any
* value, default or otherwise, is actually required.
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public static @interface ValidateDefaultValue {
boolean value() default true;
}
/**
* Read a string value and convert to a Java type.
*
* @param value The string value.
* @return the instance of the Java type.
*/
T fromString(String value);
}