public
class
CompiledStyleSet
extends Object| java.lang.Object | |
| ↳ | com.carto.styles.CompiledStyleSet |
Class Overview
Compiled style set definition for vector tiles. Compiled style sets should contains either Mapnik XML stylesheets
with all required assets or CartoCSS JSON-based project files.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
CompiledStyleSet(AssetPackage assetPackage)
Constructs a style set from the given asset package.
| |||||||||||
|
CompiledStyleSet(AssetPackage assetPackage, String styleName)
Constructs a style from the given asset package and explicit style name.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| boolean |
equals(Object obj)
Checks if this object is equal to the specified object.
| ||||||||||
| AssetPackage |
getAssetPackage()
Returns the style asset package.
| ||||||||||
| String |
getStyleAssetName()
Returns the asset name defining the current style name.
| ||||||||||
| String |
getStyleName()
Returns the current style name.
| ||||||||||
| int |
hashCode()
Returns the hash value of this object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public CompiledStyleSet (AssetPackage assetPackage)
Constructs a style set from the given asset package.
If the asset package contains multiple styles (XML or JSON files), the first one (based on lexicographical order) from the root folder is chosen as the current style.
Parameters
| assetPackage | The asset package containing compiled style set data and style definition. |
|---|
public CompiledStyleSet (AssetPackage assetPackage, String styleName)
Constructs a style from the given asset package and explicit style name.
Parameters
| assetPackage | The asset package containing compiled style set data and style definition. |
|---|---|
| styleName | The name of the style to use. |
Public Methods
public synchronized void delete ()
public boolean equals (Object obj)
Checks if this object is equal to the specified object.
Parameters
| obj | The reference object. |
|---|
Returns
- True when objects are equal, false otherwise.
public AssetPackage getAssetPackage ()
Returns the style asset package.
Returns
- The style asset package.
public String getStyleAssetName ()
Returns the asset name defining the current style name.
Returns
- The CartoCSS string used for the style.
The asset name defining the current style name.
public String getStyleName ()
Returns the current style name.
Returns
- The current style name.
public int hashCode ()
Returns the hash value of this object.
Returns
- The hash value of this object.