org.fusesource.scalate.wikitext

SnippetBlock

class SnippetBlock extends AbstractConfluenceDelimitedBlock with Logging

Represents a {snippet} block in the wiki markup

Inherited
  1. Hide All
  2. Show all
  1. Logging
  2. AbstractConfluenceDelimitedBlock
  3. ParameterizedBlock
  4. Block
  5. Processor
  6. Cloneable
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new SnippetBlock()

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef

  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any

  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any

  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef

  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef

  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef

  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any

  8. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any

  9. def beginBlock(): Unit

    definition classes: SnippetBlock → AbstractConfluenceDelimitedBlock

  10. def beginNesting(): Boolean

    definition classes: Block

  11. def canStart(arg0: String, arg1: Int): Boolean

    definition classes: AbstractConfluenceDelimitedBlock → Block

  12. def clone(): Block

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    definition classes: Block → Processor → AnyRef

  13. def debug(e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  14. def debug(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  15. def debug(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging

  16. def endBlock(): Unit

    definition classes: SnippetBlock → AbstractConfluenceDelimitedBlock

  17. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef

  18. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any

  19. def error(e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  20. def error(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  21. def error(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging

  22. def extension(url: String): String

    Extract the file extension from the URL

    Extract the file extension from the URL

  23. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

  24. def findCloseOffset(arg0: String, arg1: Int): Int

    definition classes: Block

  25. def getBuilder(): DocumentBuilder

    definition classes: Processor

  26. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

  27. def getMarkupLanguage(): MarkupLanguage

    definition classes: Processor

  28. def getParser(): MarkupParser

    definition classes: Processor

  29. def getSnippet: Iterator[String]

    Extract the snippet from the Source file

    Extract the snippet from the Source file

  30. def getState(): ContentState

    definition classes: Processor

  31. def handleBlockContent(value: String): Unit

    definition classes: SnippetBlock → AbstractConfluenceDelimitedBlock

  32. lazy val handler: SnippetHandler

  33. def hashCode(): Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any

  34. var id: Option[String]

  35. def info(e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  36. def info(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  37. def info(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging

  38. def isClosed(): Boolean

    definition classes: Block

  39. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any

  40. var lang: Option[String]

  41. def language: String

    Get the configured language or determine the language from the file extension

    Get the configured language or determine the language from the file extension

  42. def log: Log

    attributes: protected
    definition classes: Logging

  43. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef

  44. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

  45. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

  46. def processLine(arg0: String, arg1: Int): Int

    definition classes: Block

  47. def processLineContent(arg0: String, arg1: Int): Int

    definition classes: AbstractConfluenceDelimitedBlock → Block

  48. var pygmentize: Boolean

  49. def resetState(): Unit

    attributes: protected
    definition classes: AbstractConfluenceDelimitedBlock

  50. def setClosed(arg0: Boolean): Unit

    definition classes: AbstractConfluenceDelimitedBlock → Block

  51. def setOption(key: String, value: String): Unit

    definition classes: SnippetBlock → ParameterizedBlock

  52. def setOption(arg0: String): Unit

    attributes: protected
    definition classes: ParameterizedBlock

  53. def setOptions(arg0: String): Unit

    definition classes: ParameterizedBlock

  54. def setParser(arg0: MarkupParser): Unit

    definition classes: Processor

  55. def setState(arg0: ContentState): Unit

    definition classes: Processor

  56. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

  57. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: SnippetBlock → AnyRef → Any

  58. def trace(e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  59. def trace(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  60. def trace(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging

  61. var url: String

  62. def wait(): Unit

    attributes: final
    definition classes: AnyRef

  63. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

  64. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef

  65. def warn(e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  66. def warn(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging

  67. def warn(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging