要約
属性の集合を表すクラスです。
REXML::Element#attributes はこのクラスのオブジェクトを返します。各属性には REXML::Attributes#[] でアクセスします。
目次
- 特異メソッド
- インスタンスメソッド
継承しているメソッド
- Hashから継承しているメソッド
-
- <
- <=
- ==
- ===
- >
- >=
- assoc
- clear
- clone
- compact
- compact!
- compare_by_identity
- compare_by_identity?
- default
- default=
- default_proc
- default_proc=
- delete_if
- dig
- dup
- each_key
- each_pair
- each_value
- empty?
- eql?
- equal?
- except
- fetch
- fetch_values
- filter
- filter!
- flatten
- has_key?
- has_value?
- hash
- include?
- inspect
- invert
- keep_if
- key
- key?
- keys
- member?
- merge
- merge!
- rassoc
- rehash
- reject
- reject!
- replace
- select
- select!
- shift
- slice
- store
- to_h
- to_hash
- to_proc
- to_s
- transform_keys
- transform_keys!
- transform_values
- transform_values!
- update
- value?
- values
- values_at
- Enumerableから継承しているメソッド
-
- all?
- any?
- chain
- chunk
- chunk_while
- collect
- collect_concat
- count
- cycle
- detect
- drop
- drop_while
- each_cons
- each_entry
- each_slice
- each_with_index
- each_with_object
- entries
- filter_map
- find
- find_all
- find_index
- first
- flat_map
- grep
- grep_v
- group_by
- inject
- lazy
- map
- max
- max_by
- min
- min_by
- minmax
- minmax_by
- none?
- one?
- partition
- reduce
- reverse_each
- slice_after
- slice_before
- slice_when
- sort
- sort_by
- sum
- take
- take_while
- tally
- uniq
- zip
特異メソッド
new(element) -> REXML::Attributes
[permalink][rdoc][edit]-
空の Attributes オブジェクトを生成します。
どの要素の属性であるかを element で指定します。
通常は REXML::Element.new によって Attributes オブジェクトが生成されるため、このメソッドを使う必要はありません。
- [PARAM] element:
- 属性が属する要素(REXML::Element オブジェクト)
インスタンスメソッド
add(attribute) -> ()
[permalink][rdoc][edit]self << attribute -> ()
-
属性を追加/更新します。
attribute で更新する属性(REXML::Attribute オブジェクト)を指定します。既に同じ名前(REXML::Attribute#name)のオブジェクトが存在する場合は属性が上書きされ、ない場合は追加されます。
- [PARAM] attribute:
- 追加(更新)する属性(REXML::Attribute オブジェクト)
[SEE_ALSO] REXML::Attributes#[]=
self[name] -> String | nil
[permalink][rdoc][edit]-
属性名nameの属性値を返します。
属性値ではなく REXML::Attribute オブジェクトが必要な場合は REXML::Attributes#get_attribute を使ってください。
nameという属性名の属性がない場合は nil を返します。
- [PARAM] name:
- 属性名(文字列)
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first p a.attributes["att"] # => "<" p a.attributes["bar:att"] # => "2"
self[name] = value
[permalink][rdoc][edit]-
指定した属性を更新します。
name で属性の名前を、value で値を更新します。既に同じ名前の属性がある場合は上書きされ、そうでない場合は属性が追加されます。
require 'rexml/document' doc = REXML::Document.new(<<-EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes["att"] = "9" a.attributes["foo:attt"] = "8" a # => <a foo:att='1' bar:att='2' att='9' foo:attt='8'/>
[SEE_ALSO] REXML::Attributes#add
delete(attribute) -> REXML::Element
[permalink][rdoc][edit]-
指定した属性を取り除きます。
attribute で取り除く属性を指定します。文字列もしくは REXML::Attribute オブジェクトを指定します
self が属する要素(REXML::Element)を返します。
- [PARAM] attribute:
- 取り除く属性(文字列もしくは REXML::Attribute オブジェクト)
require 'rexml/document' doc = REXML::Document.new(<<-EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.delete("att") # => <a foo:att='1' bar:att='2'/> a.attributes.delete("foo:att") # => <a bar:att='2'/> attr = a.attributes.get_attribute("bar:att") a.attributes.delete(attr) # => <a/>
delete_all(name) -> [REXML::Attribute]
[permalink][rdoc][edit]-
name という名前を持つ属性をすべて削除します。
削除された属性を配列で返します。
- [PARAM] name:
- 削除する属性の名前
require 'rexml/document' doc = REXML::Document.new(<<-EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.delete_all("att") # => [att='<'] a # => <a foo:att='1' bar:att='2'/>
each {|name, value| ... } -> ()
[permalink][rdoc][edit]-
各属性の名前と値に対しブロックを呼び出します。
名前には expanded_name(REXML::Namespace#exapnded_name)が渡されます。
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.each do |name, value| p [name, value] end # => ["foo:att", "1"] # => ["bar:att", "2"] # => ["att", "<"]
each_attribute {|attribute| ... } -> ()
[permalink][rdoc][edit]-
各属性に対しブロックを呼び出します。
個々の属性は REXML::Attribute オブジェクトで渡されます。
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.each_attribute do |attr| p [attr.namespace, attr.name, attr.value] end # => ["http://example.org/foo", "att", "1"] # => ["http://example.org/bar", "att", "2"] # => ["", "att", "<"]
get_attribute(name) -> Attribute | nil
[permalink][rdoc][edit]-
name という名前の属性を取得します。
name という名前を持つ属性がない場合は nil を返します。
- [PARAM] name:
- 属性名(文字列)
[SEE_ALSO] REXML::Attributes#[]
require 'rexml/document' doc = REXML::Document.new(<<-EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.get_attribute("att") # => att='<' a.attributes.get_attribute("foo:att") # => foo:att='1'
get_attribute_ns(namespace, name) -> REXML::Attribute | nil
[permalink][rdoc][edit]-
namespace と name で特定される属性を返します。
namespace で名前空間を、 name で prefix を含まない属性名を指定します。
指定された属性が存在しない場合は nil を返します。
XML プロセッサが prefix を置き換えてしまった場合でも、このメソッドを使うことで属性を正しく指定することができます。
- [PARAM] namespace:
- 名前空間(URI, 文字列)
- [PARAM] name:
- 属性名(文字列)
require 'rexml/document' doc = REXML::Document.new(<<-EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first a.attributes.get_attribute_ns("", "att") # => att='<' a.attributes.get_attribute_ns("http://example.org/foo", "att") # => foo:att='1' a.attributes.get_attribute_ns("http://example.org/baz", "att") # => nil a.attributes.get_attribute_ns("http://example.org/foo", "attt") # => nil
length -> Integer
[permalink][rdoc][edit]size -> Integer
-
属性の個数を返します。
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first p a.attributes.length # => 3
namespaces -> { String => String }
[permalink][rdoc][edit]-
self の中で宣言されている名前空間の集合を返します。
返り値は名前空間の prefix をキーとし、URI を値とする Hash を返します。
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first p doc.root.attributes.namespaces # => {"foo"=>"http://example.org/foo", "bar"=>"http://example.org/bar"} p a.attributes.namespaces # => {}
prefixes -> [String]
[permalink][rdoc][edit]-
self の中で宣言されている prefix の集合を文字列の配列で返します。
self が属する要素より上位の要素で定義されているものは含みません。
require 'rexml/document' doc = REXML::Document.new(<<EOS) <root xmlns:foo="http://example.org/foo" xmlns:bar="http://example.org/bar"> <a foo:att='1' bar:att='2' att='<'/> </root> EOS a = doc.get_elements("/root/a").first p doc.root.attributes.prefixes # => ["foo", "bar"] p a.attributes.prefixes # => []
to_a -> [Attribute]
[permalink][rdoc][edit]-
属性の配列を返します。
require 'rexml/document' doc = REXML::Document.new("<a x='1' y='2' z='3' />") doc.root.attributes.to_a # => [x='1', y='2', z='3']