Ruby 2.6.0 リファレンスマニュアル > ライブラリ一覧 > rexml/documentライブラリ > REXML::XMLDeclクラス

class REXML::XMLDecl

クラス・モジュールの継承リスト: REXML::XMLDecl < REXML::Encoding < REXML::Child < REXML::Node < Object < Kernel < BasicObject

要約

XML 宣言を表すクラス。

文書から XML 宣言を取り出すには REXML::Document#xml_decl を使います。


require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_decl.standalone # => "yes"
xml_decl.writethis # => true

XML 宣言を省略した場合の例。

require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_decl.standalone # => nil
xml_decl.writethis # => false

XML 宣言が encoding 属性を持たない場合の例

require 'rexml/document'
doc = REXML::Document.new(<<EOS)
<?xml version="1.0" ?>
<e />
EOS

xml_decl = doc.xml_decl
xml_decl.version # => "1.0"
xml_decl.encoding # => "UTF-8"
xml_decl.standalone # => nil
xml_decl.writethis # => true

特異メソッド

定義	説明
`default -> REXML::XMLDecl`	XML宣言を含まない文章でデフォルトで使うための XMLDecl オブジェクトを生成して返します。
`new(version = REXML::XMLDecl::DEFAULT_VERSION, encoding = nil, standalone = nil)`	新たな XMLDecl オブジェクトを生成して返します。

インスタンスメソッド

定義	説明
`self == other -> bool`	self と other が同じであるならば真を返します。
`clone -> REXML::XMLDecl`	self を複製します。
`dowrite -> ()`	出力時(REXML::Document#write) に XML 宣言を省略しないよう指示します。
`encoding -> String \| nil`	設定されているエンコーディングの名前を文字列で返します。
`encoding=(enc)`	エンコーディングを enc に設定します。
`node_type -> Symbol`	シンボル :xmldecl を返します。
`nowrite -> ()`	出力時(REXML::Document#write) に XML 宣言を省略するよう指示します。
`standalone -> String \| nil stand_alone? -> String \| nil`	スタンドアロン文書であるかどうかを "yes" "no" で返します。
`standalone=(value)`	スタンドアロン文書であるかどうかを "yes" "no" で設定します。
`version -> String`	XML文書のバージョンを文字列で返します。
`version=(value)`	XML文書のバージョンを設定します。
`writeencoding -> bool`	XML宣言内の encoding の宣言を出力時に省略するならば真を返します。
`writethis -> bool`	出力時(REXML::Document#write) に XML 宣言を出力する(省略しない) ならば真を返します。
`xmldecl(version, encoding, standalone) -> ()`	内容を更新します。

定数

定義	説明
`DEFAULT_VERSION -> String`	REXML::XMLDecl.new や REXML::XMLDecl.default での使われるデフォルトのXMLバージョン。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap then to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE bytes document next_sibling next_sibling= parent parent= previous_sibling previous_sibling= remove replace_with