Resource (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.resources.Resource

All Implemented Interfaces:

java.lang.Comparable<Resource>
```
public class Resource
extends java.lang.Object
implements java.lang.Comparable<Resource>
```
Represents a java resource which is identified by a contextClass and a path. The resource will be loaded using the same class loader that was used to load the contextClass. The path consists of the class' package name plus the path. A resource object is always guaranteed to exist meaning that instantiation of a non-existent resource will fail.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Optional<Resource>`	`asOptional(java.lang.Class<?> contextClass, java.lang.String path)` Creates an instance of a resource.
`int`	`compareTo(Resource other)`
`java.io.File`	`copyTo(java.io.File file)` Copies the resource to the given file.
`boolean`	`equals(java.lang.Object o)`
`static boolean`	`exists(java.lang.Class<?> contextClass, java.lang.String path)` Returns true is the resource exists.
`java.lang.String`	`getAbsolutePath()` Returns the resource's absolute path including the `contextClass`' package name.
`static java.lang.String`	`getAbsolutePath(java.lang.Class<?> contextClass, java.lang.String path)` Returns the resource's absolute path including the `contextClass`' package name.
`byte[]`	`getAsByteArray()` Returns the resource as a raw byte array.
`java.io.InputStream`	`getAsStream()` Get resource as stream.
`java.io.File`	`getAsTmpFile()` Creates a temporary copy of the resource in the systems default temp file location.
`java.lang.String`	`getBaseName()` Returns the resource's base name without extension.
`java.lang.String`	`getContent()` Get resource as string (assuming UTF-8 encoding) with normalized line separators.
`java.lang.String`	`getContentAsRawString()` Get resource as string (assuming UTF-8 encoding) without normalized line separators.
`java.lang.Class<?>`	`getContextClass()` Returns the resource's context class.
`java.lang.String`	`getExtension()` Returns the resource's extension.
`java.util.List<java.lang.String>`	`getLines()` Returns the content of the resource split into lines.
`java.lang.String`	`getName()` Returns the name of the resource including the extension.
`java.lang.String`	`getParentPath()` Returns the resource's parent path.
`java.lang.String`	`getPath()` Returns the resource's path relative to the `contextClass` including the resource's name.
`java.lang.String`	`getPathSegmentAt(int index)` Returns only a single path segment of the resource's path.
`java.net.URL`	`getUrl()` Returns the resource's url.
`boolean`	`hasExtension(java.lang.String... extensions)` Returns true is the resource's extension matches one of the given extensions.
`int`	`hashCode()`
`long`	`lastModified()` Returns the timestamp in milliseconds of the last modification in case the underlying resource url is a file.
`static Resource`	`of(java.lang.Class<?> contextClass, java.lang.String path)` Creates an instance of a resource.
`static Resource`	`of(java.lang.Class<?> contextClass, java.lang.String path, java.net.URL url)` Creates an instance of a resource.
`java.lang.String`	`toString()`
`void`	`unzipTo(java.io.File tempDir)` Unzips the resource into into the given folder under a folder with the same name as the resource's base name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static Resource of(java.lang.Class<?> contextClass,
                          java.lang.String path)
```
    Creates an instance of a resource. If the resource does not exist and AssertionError is thrown. Check with exists(Class, String) before creating an instance in case it might be missing.
  - asOptional
```
public static java.util.Optional<Resource> asOptional(java.lang.Class<?> contextClass,
                                                      java.lang.String path)
```
    Creates an instance of a resource. Returns empty if the resource does not exist.
  - of
```
public static Resource of(java.lang.Class<?> contextClass,
                          java.lang.String path,
                          java.net.URL url)
```
    Creates an instance of a resource. If the resource does not exist an AssertionError is thrown. Check with exists(Class, String) before creating an instance in case it might be missing.
  - getAbsolutePath
```
public static java.lang.String getAbsolutePath(java.lang.Class<?> contextClass,
                                               java.lang.String path)
```
    Returns the resource's absolute path including the contextClass' package name.
  - exists
```
public static boolean exists(java.lang.Class<?> contextClass,
                             java.lang.String path)
```
    Returns true is the resource exists.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the resource including the extension.
  - getBaseName
```
public java.lang.String getBaseName()
```
    Returns the resource's base name without extension.
  - getExtension
```
public java.lang.String getExtension()
```
    Returns the resource's extension.
  - hasExtension
```
public boolean hasExtension(java.lang.String... extensions)
```
    Returns true is the resource's extension matches one of the given extensions. In contrast to getExtension() this method supports also extensions that contain dots.
  - getContextClass
```
public java.lang.Class<?> getContextClass()
```
    Returns the resource's context class.
  - getPath
```
public java.lang.String getPath()
```
    Returns the resource's path relative to the contextClass including the resource's name.
  - getUrl
```
public java.net.URL getUrl()
```
    Returns the resource's url.
  - getParentPath
```
public java.lang.String getParentPath()
```
    Returns the resource's parent path. This is the getPath() without the resource's name.
  - getAbsolutePath
```
public java.lang.String getAbsolutePath()
```
    Returns the resource's absolute path including the contextClass' package name.
  - getPathSegmentAt
```
public java.lang.String getPathSegmentAt(int index)
```
    Returns only a single path segment of the resource's path. If the index is negative the path segments are counted from the end of the path. E.g. for "base/sub/name.txt" 0=base, -1=name.txt, -2=1=sub.
  - getAsStream
```
public java.io.InputStream getAsStream()
```
    Get resource as stream.
  - getAsByteArray
```
public byte[] getAsByteArray()
```
    Returns the resource as a raw byte array.
  - getContentAsRawString
```
public java.lang.String getContentAsRawString()
```
    Get resource as string (assuming UTF-8 encoding) without normalized line separators.
  - getContent
```
public java.lang.String getContent()
```
    Get resource as string (assuming UTF-8 encoding) with normalized line separators.
  - getLines
```
public java.util.List<java.lang.String> getLines()
```
    Returns the content of the resource split into lines.
  - getAsTmpFile
```
public java.io.File getAsTmpFile()
                          throws java.io.IOException
```
    Creates a temporary copy of the resource in the systems default temp file location. The file will be marked for deletion when the JVM shuts down.
    
    Throws:
    
    java.io.IOException
  - copyTo
```
public java.io.File copyTo(java.io.File file)
                    throws java.io.IOException
```
    Copies the resource to the given file. Parent directories are created if they do not exist yet. If the file itself already exists it wil be overridden.
    
    Throws:
    
    java.io.IOException
  - unzipTo
```
public void unzipTo(java.io.File tempDir)
             throws java.io.IOException
```
    Unzips the resource into into the given folder under a folder with the same name as the resource's base name.
    
    Throws:
    
    java.io.IOException
  - compareTo
```
public int compareTo(Resource other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Resource>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - lastModified
```
public long lastModified()
```
    Returns the timestamp in milliseconds of the last modification in case the underlying resource url is a file. Returns -1 of the underlying resource is an entry in a jar file. Calling this method only makes sense after calling ResourceUtils.getFileBackedResource(Resource).

Class Resource

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

asOptional

of

getAbsolutePath

exists

getName

getBaseName

getExtension

hasExtension

getContextClass

getPath

getUrl

getParentPath

getAbsolutePath

getPathSegmentAt

getAsStream

getAsByteArray

getContentAsRawString

getContent

getLines

getAsTmpFile

copyTo

unzipTo

compareTo

toString

equals

hashCode

lastModified