VirtualResource (Apache Tomcat 8.5.57 API Documentation)

org.apache.catalina.webresources

## Class VirtualResource

- java.lang.Object
- - org.apache.catalina.webresources.EmptyResource
  - - org.apache.catalina.webresources.VirtualResource

- All Implemented Interfaces:
    WebResource

      public class VirtualResource
      extends EmptyResource

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `VirtualResource(WebResourceRoot root, String webAppPath, String name)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getName()`
    `boolean` | `isDirectory()`
    `boolean` | `isVirtual()` Indicates if this resource is required for applications to correctly scan the file structure but that does not exist in either the main or any additional `WebResourceSet`.

    - ### Methods inherited from class org.apache.catalina.webresources.EmptyResource

      `canRead, delete, exists, getCanonicalPath, getCertificates, getCodeBase, getContent, getContentLength, getCreation, getETag, getInputStream, getLastModified, getLastModifiedHttp, getManifest, getMimeType, getURL, getWebappPath, getWebResourceRoot, isFile, setMimeType`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### VirtualResource

          public VirtualResource(WebResourceRoot root,
                         String webAppPath,
                         String name)

  - ### Method Detail

    - #### isVirtual

          public boolean isVirtual()

      Description copied from interface: `WebResource`
      Indicates if this resource is required for applications to correctly scan the file structure but that does not exist in either the main or any additional `WebResourceSet`. For example, if an external directory is mapped to /WEB-INF/lib in an otherwise empty web application, /WEB-INF will be represented as a virtual resource.
      Specified by:
        `isVirtual` in interface `WebResource`
      Overrides:
        `isVirtual` in class `EmptyResource`
      Returns:
        `true` for a virtual resource

    - #### isDirectory

          public boolean isDirectory()

      Specified by:
        `isDirectory` in interface `WebResource`
      Overrides:
        `isDirectory` in class `EmptyResource`
      Returns:
        `File.isDirectory()`.

    - #### getName

          public String getName()

      Specified by:
        `getName` in interface `WebResource`
      Overrides:
        `getName` in class `EmptyResource`
      Returns:
        `File.getName()`.

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.