Ruby REXML::Entity Functions

EditRocket provides the following information on REXML::Entity functions in the Ruby source code builder.

matches?(string) - Evaluates whether the given string matchs an entity definition, returning true if so, and false otherwise.

new(stream, value=nil, parent=nil, reference=false) - "Create a new entity. Simple entities can be constructed by passing a name, value to the constructor; this creates a generic, plain entity reference. For anything more complicated, you have to pass a Source to the constructor with the entity definiton, or use the accessor methods. WARNING: There is no validation of entity state except when the entity is read from a stream. If you start poking around with the accessors, you can easily create a non-conformant Entity. The best thing to do is dump the stupid DTDs and use XMLSchema instead."

normalized() - Returns the value of this entity unprocessed -- raw. This is the normalized value; that is, with all %ent; and &ent; entities intact

to_s() - Returns this entity as a string. See write().

unnormalized() - Evaluates to the unnormalized value of this entity; that is, replacing all entities -- both %ent; and &ent; entities. This differs from +value()+ in that value only replaces %ent; entities.

value() - "Returns the value of this entity. At the moment, only internal entities are processed. If the value contains internal references (IE, %blah;), those are replaced with their values. IE, if the doctype contains:"

write(out, indent=-1) - Write out a fully formed, correct entity definition (assuming the Entity object itself is valid.)