org.jboss.marshalling.ProviderDescriptor Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.marshalling;
/**
* A provider descriptor for automatically-discovered marshalling factory types. Since instances of this interface are
* constructed automatically, implementing classes should have a no-arg constructor.
*
* To add an automatically-discovered marshaller, create a file called {@code "META-INF/services/org.jboss.marshalling.ProviderDescriptor"}
* and populate it with the names of classes that implement this interface.
*
* @see java.util.ServiceLoader
* @apiviz.landmark
*/
public interface ProviderDescriptor {
/**
* Get the name of this provider.
*
* @return the provider name
*/
String getName();
/**
* Get the supported wire protocol versions for this provider, in descending order.
*
* @return the supported versions in descending order
*/
int[] getSupportedVersions();
/**
* Get the marshaller factory instance for this provider.
*
* @return the marshaller factory
*/
MarshallerFactory getMarshallerFactory();
}