Resource (Atlassian Plugins - Web Resources 3.5.41 API)

java.lang.Object
- com.atlassian.plugin.webresource.impl.snapshot.Resource

Direct Known Subclasses:

ContextResource, ModuleResource
```
public class Resource
extends Object
```
Resource of Web Resource or Plugin.

Since:

3.3

Constructor Summary

Constructors
Constructor and Description
`Resource(Bundle parent, com.atlassian.plugin.elements.ResourceLocation resourceLocation, String nameType, String locationType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Content`	`getContent()`
`String`	`getContentType()`
`String`	`getFilePath()` Deprecated. since 3.3.2
`String`	`getFullName()`
`String`	`getKey()`
`String`	`getLocation()`
`String`	`getLocationType()`
`String`	`getName()`
`String`	`getNameOrLocationType()`
`String`	`getNameType()`
`Map<String,String>`	`getParams()`
`Bundle`	`getParent()` Get Parent - Web Resource or Plugin.
`String`	`getPath()` The actual path of the resource consist of two parts - the location and the file path.
`static String`	`getPrebuiltSourcePath(String resourceName)`
`com.atlassian.plugin.elements.ResourceLocation`	`getResourceLocation()` Deprecated. since 3.3.2
`static String`	`getResourceNameFromPrebuiltSourceName(String prebuiltSourcePath)`
`InputStream`	`getStreamFor(String path)`
`Map<String,String>`	`getUrlParams()` Get only those parameters that would be output to url.
`static Map<String,String>`	`getUrlParamsStatic(Map<String,String> params)`
`String`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isBatchable()`
`boolean`	`isBatchable(Map<String,String> batchParams)` Should it be included in Batch with given Parameters?
`boolean`	`isCacheable()`
`static boolean`	`isCacheableStatic(Map<String,String> params)`
`static boolean`	`isPrebuiltSourceName(String name)`
`boolean`	`isRedirect()`
`boolean`	`isTransformable()`
`String`	`toString()`

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

Constructor Detail

Resource

public Resource(Bundle parent,
                com.atlassian.plugin.elements.ResourceLocation resourceLocation,
                String nameType,
                String locationType)

Method Detail

getParent
```
public Bundle getParent()
```
Get Parent - Web Resource or Plugin.

getName
```
public String getName()
```

getFullName
```
public String getFullName()
```

getLocation
```
public String getLocation()
```

isRedirect
```
public boolean isRedirect()
```

getNameType
```
public String getNameType()
```

getNameOrLocationType
```
public String getNameOrLocationType()
```

getLocationType
```
public String getLocationType()
```

getContentType
```
public String getContentType()
```

isBatchable
```
public boolean isBatchable()
```

getStreamFor

public InputStream getStreamFor(String path)

getPath
```
public String getPath()
```
The actual path of the resource consist of two parts - the location and the file path. So, this method returns the actual path to the file.

isBatchable
```
public boolean isBatchable(Map<String,String> batchParams)
```
Should it be included in Batch with given Parameters?

getParams
```
public Map<String,String> getParams()
```

getUrlParams
```
public Map<String,String> getUrlParams()
```
Get only those parameters that would be output to url.

getUrlParamsStatic

public static Map<String,String> getUrlParamsStatic(Map<String,String> params)

isTransformable
```
public boolean isTransformable()
```

getVersion
```
public String getVersion()
```

getKey
```
public String getKey()
```

isCacheable
```
public boolean isCacheable()
```

isCacheableStatic

public static boolean isCacheableStatic(Map<String,String> params)

getContent
```
public Content getContent()
```

getResourceLocation

@Deprecated
public com.atlassian.plugin.elements.ResourceLocation getResourceLocation()

Deprecated. since 3.3.2

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

getFilePath
```
@Deprecated
public String getFilePath()
```
Deprecated. since 3.3.2

There's a method `getFilePath` on the resource but no the `filePath` variable itself, this is done in order to not take additional memory. The case when the `filePath` is different from the empty string is rare, and handled by overriding this method.

getPrebuiltSourcePath

public static String getPrebuiltSourcePath(String resourceName)

isPrebuiltSourceName

public static boolean isPrebuiltSourceName(String name)

getResourceNameFromPrebuiltSourceName

public static String getResourceNameFromPrebuiltSourceName(String prebuiltSourcePath)

Class Resource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Resource

Method Detail

getParent

getName

getFullName

getLocation

isRedirect

getNameType

getNameOrLocationType

getLocationType

getContentType

isBatchable

getStreamFor

getPath

isBatchable

getParams

getUrlParams

getUrlParamsStatic

isTransformable

getVersion

getKey

isCacheable

isCacheableStatic

getContent

getResourceLocation

equals

hashCode

toString

getFilePath

getPrebuiltSourcePath

isPrebuiltSourceName

getResourceNameFromPrebuiltSourceName