com.liferay.adaptive.media.image.scaler.AMImageScalerTracker Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library 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 library 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.
*/
package com.liferay.adaptive.media.image.scaler;
/**
* Tracks the image scalers and returns the one used for a specific MIME type.
*
*
* Every image scaler registered in OSGi with the mime.type
* property is tracked. Multiple image scalers can be registered for the same
* MIME type, but the tracker returns only one.
*
*
*
* The image scalers are grouped by mime.type and ordered by the
* service.ranking property. The image scaler returns the first
* image scaler of the group whose {@link AMImageScaler#isEnabled()} method
* returns true.
*
*
*
* If no enabled image scalers are registered for the specific MIME type, it
* searches for the enabled image scaler with the highest
* service.ranking that's registered with the * MIME
* type. If no enabled image scalers are registered for the * MIME
* type, it returns null.
*
*
* @author Sergio González
*/
public interface AMImageScalerTracker {
/**
* Returns the enabled image scaler for the specific MIME type.
*
* @param mimeType the MIME type
* @return the image scaler
*/
public AMImageScaler getAMImageScaler(String mimeType);
}