FileExtension.java
/*
* #%L
* wcm.io
* %%
* Copyright (C) 2014 wcm.io
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package io.wcm.wcm.commons.contenttype;
import java.util.Collections;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;
/**
* Frequently used file extensions.
*/
@ProviderType
@SuppressWarnings("null")
public final class FileExtension {
private FileExtension() {
// constants only
}
/**
* HTML
*/
public static final String HTML = "html";
/**
* HTML, configured as non-caching
*/
public static final String HTML_UNCACHED = "htx";
/**
* JSON
*/
public static final String JSON = "json";
/**
* Plain text
*/
public static final String PLAINTEXT = "txt";
/**
* CSS
*/
public static final String CSS = "css";
/**
* JavaScript
*/
public static final String JAVASCRIPT = "js";
/**
* XML
*/
public static final String XML = "xml";
/**
* XHTML
*/
public static final String XHTML = "html";
/**
* ZIP
*/
public static final String ZIP = "zip";
/**
* GIF image
*/
public static final String GIF = "gif";
/**
* JPEG image
*/
public static final String JPEG = "jpg";
/**
* PNG image
*/
public static final String PNG = "png";
/**
* Flash file
*/
public static final String SWF = "swf";
/**
* CSV
*/
public static final String CSV = "csv";
/**
* PDF
*/
public static final String PDF = "pdf";
/**
* SVG
*/
public static final String SVG = "svg";
/**
* TIFF
*/
public static final String TIFF = "tif";
/**
* WebP
*/
public static final String WEBP = "webp";
/**
* all file extensions that will be displayed by an image tag
*/
private static final Set<String> IMAGE_FILE_EXTENSIONS = Set.of(
GIF,
JPEG,
PNG,
"jpeg" // check for this alternative JEPG extension as well
);
/**
* all file extensions that will be displayed as flash
*/
private static final Set<String> FLASH_FILE_EXTENSIONS = Set.of(
SWF
);
/**
* Check if the given file extension is a standard image format supported by web browsers and AEM Layer
* implementations.
* @param fileExtension File extension
* @return true if image
* @deprecated Use <code>io.wcm.handler.media.MediaFileType.isImage</code> instead.
*/
@Deprecated(since = "1.5.0")
public static boolean isImage(@Nullable String fileExtension) {
if (StringUtils.isEmpty(fileExtension)) {
return false;
}
return IMAGE_FILE_EXTENSIONS.contains(fileExtension.toLowerCase());
}
/**
* @return Image file extensions for standard image formats supported by web browsers and AEM Layer implementations.
* @deprecated Use <code>io.wcm.handler.media.MediaFileType.getImageFileExtensions</code> instead.
*/
@Deprecated(since = "1.5.0")
public static @NotNull Set<String> getImageFileExtensions() {
return Collections.unmodifiableSet(IMAGE_FILE_EXTENSIONS);
}
/**
* Check if the given file extension is an flash.
* @param fileExtension File extension
* @return true if flash
* @deprecated Use <code>io.wcm.handler.media.MediaFileType.isFlash</code> instead.
*/
@Deprecated(since = "1.5.0")
public static boolean isFlash(@Nullable String fileExtension) {
if (StringUtils.isEmpty(fileExtension)) {
return false;
}
return FLASH_FILE_EXTENSIONS.contains(fileExtension.toLowerCase());
}
/**
* @return Flash file extensions
* @deprecated Use <code>io.wcm.handler.media.MediaFileType.getFlashFileExtensions</code> instead.
*/
@Deprecated(since = "1.5.0")
public static @NotNull Set<String> getFlashFileExtensions() {
return Collections.unmodifiableSet(FLASH_FILE_EXTENSIONS);
}
}