org.fusesource.scalate.support

FileResource

class FileResource(file: File, uri: String) extends WriteableResource with Product

Can act as a RichFile type interface too, adding a number of extra helper methods to make Files more rich

go to: companion
known subclasses: FileTemplateSource
Inherited
  1. Hide All
  2. Show all
  1. Product
  2. Equals
  3. WriteableResource
  4. Resource
  5. Logging
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance constructors

  1. new FileResource(file: File, uri: String)

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 /(name: String): FileResource

    Create a child file

    Create a child file

  7. 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
  8. 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
  9. def andDescendants: Iterable[File]

    Returns an Iterable over this file and any descending files

    Returns an Iterable over this file and any descending files

  10. implicit def asFile: File

    attributes: implicit
  11. 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
  12. def canEqual(arg0: Any): Boolean

    definition classes: FileResource → Equals
  13. def children: Iterable[File]

    Returns an Iterable over the immediate children of this directory or an empty Iterable

    Returns an Iterable over the immediate children of this directory or an empty Iterable

  14. def clone(): AnyRef

    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.

    attributes: protected
    definition classes: AnyRef
  15. def debug(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  16. def debug(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  17. def debug(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  18. def descendants: Iterable[File]

    Returns an Iterable over any descending files

    Returns an Iterable over any descending files

  19. 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
  20. 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: FileResource → Equals → AnyRef → Any
  21. def error(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  22. def error(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  23. def error(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  24. def extension: String

    Returns the extension of the file

    Returns the extension of the file

  25. val file: File

  26. 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
  27. 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
  28. 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: FileResource → AnyRef → Any
  29. def info(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  30. def info(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  31. def info(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  32. def inputStream: FileInputStream

    Returns the input stream of the content of the resource

    Returns the input stream of the content of the resource

    definition classes: FileResourceResource
  33. 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
  34. def lastModified: Long

    Returns the last modified time of the resource

    Returns the last modified time of the resource

    definition classes: FileResourceResource
  35. def log: Log

    attributes: protected
    definition classes: Logging
  36. def name: String

  37. def nameDropExtension: String

    Returns the name of the file without its extension

    Returns the name of the file without its extension

  38. 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
  39. 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
  40. 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
  41. def outputStream: FileOutputStream

    Returns the output stream of the resource

    Returns the output stream of the resource

    definition classes: FileResourceWriteableResource
  42. def productArity: Int

    definition classes: FileResource → Product
  43. def productElement(arg0: Int): Any

    definition classes: FileResource → Product
  44. def productElements: Iterator[Any]

    definition classes: Product
      deprecated:
    1. use productIterator instead

  45. def productIterator: Iterator[Any]

    definition classes: Product
  46. def productPrefix: String

    definition classes: FileResource → Product
  47. def reader: FileReader

    Returns the reader of the content of the resource

    Returns the reader of the content of the resource

    definition classes: FileResourceResource
  48. def recursiveFind(f: (File) ⇒ Boolean): Option[File]

    Recursively finds the first file in this directory that matches the given predicate or matches against this file for non-directories

    Recursively finds the first file in this directory that matches the given predicate or matches against this file for non-directories

  49. def relativeUri(root: File): String

    Returns the relative URI of this file from the given root directory

    Returns the relative URI of this file from the given root directory

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

    attributes: final
    definition classes: AnyRef
  51. def text: String

    Returns the text content of the resource

    Returns the text content of the resource

    definition classes: FileResourceResource
  52. def text_=(value: String): Unit

    Writes text to the resource replacing its previous content

    Writes text to the resource replacing its previous content

    definition classes: WriteableResource
  53. def toFile: Some[File]

    definition classes: FileResourceResource
  54. 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: FileResource → AnyRef → Any
  55. def trace(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  56. def trace(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  57. def trace(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  58. val uri: String

    Returns the URI of the resource

    Returns the URI of the resource

    definition classes: FileResourceResource
  59. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  60. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  61. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef
  62. def warn(e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  63. def warn(message: ⇒ String, e: Throwable): Unit

    attributes: protected
    definition classes: Logging
  64. def warn(message: ⇒ String): Unit

    attributes: protected
    definition classes: Logging
  65. def writer: Writer

    Returns the writer to the content of the resource

    Returns the writer to the content of the resource

    definition classes: WriteableResource