Packages

macro class nameBasedXml extends Annotation with StaticAnnotation

This annotation enables name based XML literal.

All XML literals in methods that are annotated as nameBasedXml will be transformed to calls to functions in xml object.

import scala.language.dynamics
object xml {
  object texts extends Dynamic {
    def selectDynamic(value: String) = value
  }
  case class interpolation(expression: Any)
  object uris {
    object http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus1 {
      object elements {
        case class tagName2(attributesAndChildren: Any*)
      }
    }
    object http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus2 {
      object attributes {
        case class attribute3(attributeValue: Any)
      }
      case class interpolation(expression: Any)
    }
  }
  @inline def noPrefix[Uri](uri: Uri) = uri
  object prefixes extends Dynamic {
    @inline def applyDynamic[Uri](prefix: String)(uri: Uri) = uri
  }
  case class literal[A](a: A*)
  object elements {
    case class tagName1(attributesAndChildren: Any*)
  }
  object attributes {
    case class attribute1(attributeValue: Any)
    case class attribute2(attributeValue: Any)
  }
  object values extends Dynamic {
    def selectDynamic(value: String) = value
  }
}
Annotations
@compileTimeOnly( ... )
Source
nameBasedXml.scala
Examples:

  1. Self-closing tags without prefixes

    @nameBasedXml
def myXml = <tagName1/>
myXml should be(xml.literal(xml.elements.tagName1()))
    2. ,

  2. Self-closing tags with some prefixes

    @nameBasedXml
def myXml = <prefix1:tagName2 xmlns:prefix1="http://example.com/my-namespace-1"/>
myXml should be(xml.literal(xml.prefixes.prefix1(xml.uris.http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus1).elements.tagName2()))
    3. ,

  3. Node list

    @nameBasedXml
def myXml = <tagName1/><prefix1:tagName2 xmlns:prefix1="http://example.com/my-namespace-1"/>
myXml should be(xml.literal(xml.elements.tagName1(), xml.prefixes.prefix1(xml.uris.http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus1).elements.tagName2()))
    4. ,

  4. Attributes

    case class f()

@nameBasedXml
def myXml = <tagName1 xmlns:prefix2="http://example.com/my-namespace-2" attribute1="special character: `"
  attribute2={ f() }
  prefix2:attribute3={"value"}
/>
myXml should be(xml.literal(
  xml.elements.tagName1(
    xml.attributes.attribute1("special character: `"),
    xml.attributes.attribute2(xml.interpolation(f())),
    xml.uris.http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus2.attributes.attribute3(xml.uris.http$colon$div$divexample$u002Ecom$divmy$minusnamespace$minus2.interpolation("value"))
  )
))
See also

Pre SIP: name based XML literals

Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. nameBasedXml
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new nameBasedXml()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from nameBasedXml to any2stringadd[nameBasedXml] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (nameBasedXml, B)
    Implicit
    This member is added by an implicit conversion from nameBasedXml to ArrowAssoc[nameBasedXml] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (nameBasedXml) ⇒ Boolean, msg: ⇒ Any): nameBasedXml
    Implicit
    This member is added by an implicit conversion from nameBasedXml to Ensuring[nameBasedXml] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (nameBasedXml) ⇒ Boolean): nameBasedXml
    Implicit
    This member is added by an implicit conversion from nameBasedXml to Ensuring[nameBasedXml] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): nameBasedXml
    Implicit
    This member is added by an implicit conversion from nameBasedXml to Ensuring[nameBasedXml] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): nameBasedXml
    Implicit
    This member is added by an implicit conversion from nameBasedXml to Ensuring[nameBasedXml] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from nameBasedXml to StringFormat[nameBasedXml] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. macro def macroTransform(annottees: Any*): Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  28. def →[B](y: B): (nameBasedXml, B)
    Implicit
    This member is added by an implicit conversion from nameBasedXml to ArrowAssoc[nameBasedXml] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from nameBasedXml to any2stringadd[nameBasedXml]

Inherited by implicit conversion StringFormat from nameBasedXml to StringFormat[nameBasedXml]

Inherited by implicit conversion Ensuring from nameBasedXml to Ensuring[nameBasedXml]

Inherited by implicit conversion ArrowAssoc from nameBasedXml to ArrowAssoc[nameBasedXml]

Ungrouped