FileExtension.java

  1. /*
  2.  * #%L
  3.  * wcm.io
  4.  * %%
  5.  * Copyright (C) 2014 wcm.io
  6.  * %%
  7.  * Licensed under the Apache License, Version 2.0 (the "License");
  8.  * you may not use this file except in compliance with the License.
  9.  * You may obtain a copy of the License at
  10.  *
  11.  *      http://www.apache.org/licenses/LICENSE-2.0
  12.  *
  13.  * Unless required by applicable law or agreed to in writing, software
  14.  * distributed under the License is distributed on an "AS IS" BASIS,
  15.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16.  * See the License for the specific language governing permissions and
  17.  * limitations under the License.
  18.  * #L%
  19.  */
  20. package io.wcm.wcm.commons.contenttype;

  22. import java.util.Collections;
  23. import java.util.Set;

  25. import org.apache.commons.lang3.StringUtils;
  26. import org.jetbrains.annotations.NotNull;
  27. import org.jetbrains.annotations.Nullable;
  28. import org.osgi.annotation.versioning.ProviderType;

  30. /**
  31.  * Frequently used file extensions.
  32.  */
  33. @ProviderType
  34. @SuppressWarnings("null")
  35. public final class FileExtension {

  37.   private FileExtension() {
  38.     // constants only
  39.   }

  41.   /**
  42.    * HTML
  43.    */
  44.   public static final String HTML = "html";

  46.   /**
  47.    * HTML, configured as non-caching
  48.    */
  49.   public static final String HTML_UNCACHED = "htx";

  51.   /**
  52.    * JSON
  53.    */
  54.   public static final String JSON = "json";

  56.   /**
  57.    * Plain text
  58.    */
  59.   public static final String PLAINTEXT = "txt";

  61.   /**
  62.    * CSS
  63.    */
  64.   public static final String CSS = "css";

  66.   /**
  67.    * JavaScript
  68.    */
  69.   public static final String JAVASCRIPT = "js";

  71.   /**
  72.    * XML
  73.    */
  74.   public static final String XML = "xml";

  76.   /**
  77.    * XHTML
  78.    */
  79.   public static final String XHTML = "html";

  81.   /**
  82.    * ZIP
  83.    */
  84.   public static final String ZIP = "zip";

  86.   /**
  87.    * GIF image
  88.    */
  89.   public static final String GIF = "gif";

  91.   /**
  92.    * JPEG image
  93.    */
  94.   public static final String JPEG = "jpg";

  96.   /**
  97.    * PNG image
  98.    */
  99.   public static final String PNG = "png";

  101.   /**
  102.    * Flash file
  103.    */
  104.   public static final String SWF = "swf";

  106.   /**
  107.    * CSV
  108.    */
  109.   public static final String CSV = "csv";

  111.   /**
  112.    * PDF
  113.    */
  114.   public static final String PDF = "pdf";

  116.   /**
  117.    * SVG
  118.    */
  119.   public static final String SVG = "svg";

  121.   /**
  122.    * TIFF
  123.    */
  124.   public static final String TIFF = "tif";

  126.   /**
  127.    * WebP
  128.    */
  129.   public static final String WEBP = "webp";


  132.   /**
  133.    * all file extensions that will be displayed by an image tag
  134.    */
  135.   private static final Set<String> IMAGE_FILE_EXTENSIONS = Set.of(
  136.       GIF,
  137.       JPEG,
  138.       PNG,
  139.       "jpeg" // check for this alternative JEPG extension as well
  140.       );

  142.   /**
  143.    * all file extensions that will be displayed as flash
  144.    */
  145.   private static final Set<String> FLASH_FILE_EXTENSIONS = Set.of(
  146.       SWF
  147.       );

  149.   /**
  150.    * Check if the given file extension is a standard image format supported by web browsers and AEM Layer
  151.    * implementations.
  152.    * @param fileExtension File extension
  153.    * @return true if image
  154.    * @deprecated Use <code>io.wcm.handler.media.MediaFileType.isImage</code> instead.
  155.    */
  156.   @Deprecated(since = "1.5.0")
  157.   public static boolean isImage(@Nullable String fileExtension) {
  158.     if (StringUtils.isEmpty(fileExtension)) {
  159.       return false;
  160.     }
  161.     return IMAGE_FILE_EXTENSIONS.contains(fileExtension.toLowerCase());
  162.   }

  164.   /**
  165.    * @return Image file extensions for standard image formats supported by web browsers and AEM Layer implementations.
  166.    * @deprecated Use <code>io.wcm.handler.media.MediaFileType.getImageFileExtensions</code> instead.
  167.    */
  168.   @Deprecated(since = "1.5.0")
  169.   public static @NotNull Set<String> getImageFileExtensions() {
  170.     return Collections.unmodifiableSet(IMAGE_FILE_EXTENSIONS);
  171.   }

  173.   /**
  174.    * Check if the given file extension is an flash.
  175.    * @param fileExtension File extension
  176.    * @return true if flash
  177.    * @deprecated Use <code>io.wcm.handler.media.MediaFileType.isFlash</code> instead.
  178.    */
  179.   @Deprecated(since = "1.5.0")
  180.   public static boolean isFlash(@Nullable String fileExtension) {
  181.     if (StringUtils.isEmpty(fileExtension)) {
  182.       return false;
  183.     }
  184.     return FLASH_FILE_EXTENSIONS.contains(fileExtension.toLowerCase());
  185.   }

  187.   /**
  188.    * @return Flash file extensions
  189.    * @deprecated Use <code>io.wcm.handler.media.MediaFileType.getFlashFileExtensions</code> instead.
  190.    */
  191.   @Deprecated(since = "1.5.0")
  192.   public static @NotNull Set<String> getFlashFileExtensions() {
  193.     return Collections.unmodifiableSet(FLASH_FILE_EXTENSIONS);
  194.   }

  196. }
Created with JaCoCo 0.8.13.202504020838