com.sun.jersey.api.wadl.config.WadlGeneratorDescription Maven / Gradle / Ivy
/*
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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 https://jersey.dev.java.net/CDDL+GPL.html
* or jersey/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 jersey/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.api.wadl.config;
import java.io.File;
import java.io.InputStream;
import java.util.Properties;
import com.sun.jersey.server.wadl.WadlGenerator;
/**
* This is the model for the definition of wadl generators via configuration properties.
* The properties refer to the properties of the {@link WadlGenerator} implementation with
* the specified {@link WadlGeneratorDescription#getGeneratorClass()}. The {@link WadlGenerator} properties
* are populated with the provided properties like this:
*
* - The types match exactly:
if the WadlGenerator property is of type org.example.Foo and the
* provided property value is of type org.example.Foo
* - Types that provide a constructor for the provided type (mostly java.lang.String)
* - The WadlGenerator property is of type {@link InputStream}: The stream is loaded from the
* property value (provided by the {@link WadlGeneratorDescription}) via
* {@link ClassLoader#getResourceAsStream(String)}. It will be closed after {@link WadlGenerator#init()} was called.
*
*
* - Deprected, will be removed in future versions:
* The WadlGenerator property is of type {@link File} and the provided property value is a {@link String}:
* the provided property value can contain the prefix classpath: to denote, that the
* path to the file is relative to the classpath. In this case, the property value is stripped by
* the prefix classpath: and the {@link File} is created via
* new File( generator.getClass().getResource( strippedFilename ).toURI() )
* Notice that the filename is loaded from the classpath in this case, e.g. classpath:test.xml
* refers to a file in the package of the class ({@link WadlGeneratorDescription#getGeneratorClass()}). The
* file reference classpath:/test.xml refers to a file that is in the root of the classpath.
*
*
*
*
* @author Martin Grotzke
* @version $Id: WadlGeneratorDescription.java 2357 2009-05-12 21:47:34Z magrokosmos $
*/
public class WadlGeneratorDescription {
private Class _generatorClass;
private Properties _properties;
public WadlGeneratorDescription() {
}
public WadlGeneratorDescription( Class generatorClass, Properties properties ) {
_generatorClass = generatorClass;
_properties = properties;
}
/**
* @return the generatorClass
*/
public Class getGeneratorClass() {
return _generatorClass;
}
/**
* @param generatorClass the generatorClass to set
*/
public void setGeneratorClass( Class generatorClass ) {
_generatorClass = generatorClass;
}
/**
* @return the properties
*/
public Properties getProperties() {
return _properties;
}
/**
* @param properties the properties to set
*/
public void setProperties( Properties properties ) {
_properties = properties;
}
}