com.threerings.media.tile.tools.xml
Class UniformTileSetRuleSet

java.lang.Object
  org.apache.commons.digester.RuleSetBase
      com.threerings.media.tile.tools.xml.TileSetRuleSet
          com.threerings.media.tile.tools.xml.UniformTileSetRuleSet

All Implemented Interfaces:

ValidatedSetNextRule.Validator, org.apache.commons.digester.RuleSet

public class UniformTileSetRuleSet
extends TileSetRuleSet

Parses UniformTileSet instances from a tileset description. A uniform tileset description looks like so: <tileset name="Sample Uniform Tileset"> <imagePath>path/to/image.png</imagePath> <!-- the width of each tile in pixels --> <width>64</width> <!-- the height of each tile in pixels --> <height>48</height> </tileset>

Field Summary

Fields inherited from class com.threerings.media.tile.tools.xml.TileSetRuleSet

_path, _tilesetPath, TILESET_PATH

Fields inherited from class org.apache.commons.digester.RuleSetBase

namespaceURI

Constructor Summary

UniformTileSetRuleSet()

UniformTileSetRuleSet(String tilesetPath)

Method Summary

void	addRuleInstances(org.apache.commons.digester.Digester digester) Adds the necessary rules to the digester to parse our tilesets.
protected Class<? extends TileSet>	getTileSetClass() A tileset rule set will create tilesets of a particular class, which must be provided by the derived class via this method.
boolean	isValid(Object target) The ruleset can be provided to a ValidatedSetNextRule to ensure that the tileset was fully parsed before doing something with it.

Methods inherited from class com.threerings.media.tile.tools.xml.TileSetRuleSet

getPath, setPrefix

Methods inherited from class org.apache.commons.digester.RuleSetBase

getNamespaceURI

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformTileSetRuleSet

public UniformTileSetRuleSet()

UniformTileSetRuleSet

public UniformTileSetRuleSet(String tilesetPath)

Method Detail

addRuleInstances

public void addRuleInstances(org.apache.commons.digester.Digester digester)

Description copied from class: TileSetRuleSet

Adds the necessary rules to the digester to parse our tilesets. Derived classes should override this method, being sure to call the superclass method and then adding their own rule instances (which should register themselves relative to the _prefix member).

Specified by:

addRuleInstances in interface org.apache.commons.digester.RuleSet

Overrides:

addRuleInstances in class TileSetRuleSet

isValid

public boolean isValid(Object target)

Description copied from class: TileSetRuleSet

The ruleset can be provided to a ValidatedSetNextRule to ensure that the tileset was fully parsed before doing something with it.

Specified by:

isValid in interface ValidatedSetNextRule.Validator

Overrides:

isValid in class TileSetRuleSet

getTileSetClass

protected Class<? extends TileSet> getTileSetClass()

Description copied from class: TileSetRuleSet

A tileset rule set will create tilesets of a particular class, which must be provided by the derived class via this method.

Specified by:

getTileSetClass in class TileSetRuleSet