tec.units.tck.util.ServiceConfiguration Maven / Gradle / Ivy
Show all versions of unit-tck Show documentation
/*
* Units of Measurement TCK
* Copyright © 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
* and the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package tec.units.tck.util;
import javax.measure.Dimension;
import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.UnitConverter;
import javax.measure.format.UnitFormat;
import java.util.Collection;
import java.util.ServiceLoader;
/**
* Libraries that implement this JSR and want to be tested with this TCK must implement this
* interface and register it using the {@link ServiceLoader}.
*
* @author Werner Keil
* @version 1.0.1, Sep 10, 2017
* @since 1.0
*/
public interface ServiceConfiguration{
/**
* Return a collection with all {@link Quantity} classes that are implemented. The list
* must not be empty and should contain every quantity class implemented.
* This enables the TCK to check in addition to the basic implementation compliance, if
* according {@link ServiceProvider} is registered/available.
*
* @return a collection with all implemented amount classes, not null.
*/
@SuppressWarnings("rawtypes")
Collection getQuantityClasses();
/**
* List a collection of {@link Unit} implementations.
* This enables the TCK to check the basic implementation compliance.
*
* @return a collection with Unit implementations to be tested.
*/
@SuppressWarnings("rawtypes")
Collection getUnitClasses();
/**
* List a collection of {@link Dimension} implementations.
* This enables the TCK to check the basic implementation compliance.
*
* @return a collection with {@link Dimension} implementations to be tested.
*/
@SuppressWarnings("rawtypes")
Collection getDimensionClasses();
/**
* Return a collection with all supported {@link Quantity} types. The list
* must not return null, but could be empty in certain profiles.
*
* @return the list of quantity types to be checked, not null. It is allowed to return an empty list here, which will
*
* @return a collection with all implemented amount classes, not null.
*/
@SuppressWarnings("rawtypes")
Collection> getSupportedQuantityTypes();
/**
* Returns a matching unit for the specified quantity type.
* This is a "helper method" to avoid direct references to {@link SystemOfUnits} or implementations in profiles without SPI.
*
* @param
* the compile-time quantity type.
* @param quantityType
* the quantity type.
* @return the unit for the specified quantity.
*/
public > Unit getUnit4Type(Class quantityType);
/**
* This method allows instances of Unit to be tested for requirements and recommendations.
*
* @return the list of units to be checked, not null. It is allowed to return an empty list here, which will
* disable certain TCK tests, e.g. if the result isn't needed by a particular profile.
*/
Collection> getUnits4Test();
/**
* This method returns the base dimensions to be tested for requirements and recommendations.
*
* @return the list of base dimensions to be checked, not null. It is allowed to return an empty list here, which will
* disable certain TCK tests, e.g. if the result isn't needed by a particular profile.
*/
Collection getBaseDimensions();
/**
* This method allows instances of UnitConverter to be tested for requirements and recommendations.
*
* @return the list of unit converters to be checked, not null. It is allowed to return an empty list here, which will
* disable TCK tests for UnitConverter instances.
*/
Collection getUnitConverters4Test();
/**
* This method allows instances of UnitFormat to be tested for requirements and recommendations.
*
* @return the list of unit converters to be checked, not null. It is allowed to return an empty list here, which will
* disable certain TCK tests, e.g. if the result isn't needed by a particular profile.
*/
Collection getUnitFormats4Test();
}