docs/source/java/org/simgrid/msg/Storage.rst

   1 class org.simgrid.msg.Storage
   2 =============================
   3
   4 .. java:package:: org.simgrid.msg
   5    :noindex:
   6
   7 .. java:type:: public class Storage
   8
   9 Fields
  10 ------
  11 name
  12 ^^^^
  13
  14 .. java:field:: protected String name
  15    :outertype: Storage
  16
  17    Storage name
  18
  19 Methods
  20 -------
  21 all
  22 ^^^
  23
  24 .. java:method:: public static native Storage[] all()
  25    :outertype: Storage
  26
  27    This static method returns all of the storages of the installed platform.
  28
  29    :return: An array containing all the storages installed.
  30
  31 getByName
  32 ^^^^^^^^^
  33
  34 .. java:method:: public static native Storage getByName(String name) throws HostNotFoundException, StorageNotFoundException
  35    :outertype: Storage
  36
  37    This static method gets a storage instance associated with a native storage of your platform. This is the best way to get a java storage object.
  38
  39    :param name: The name of the storage to get.
  40    :throws StorageNotFoundException: if the name of the storage is not valid.
  41    :return: The storage object with the given name.
  42
  43 getFreeSize
  44 ^^^^^^^^^^^
  45
  46 .. java:method:: public native long getFreeSize()
  47    :outertype: Storage
  48
  49    This method returns the free size (in bytes) of a storage element.
  50
  51    :return: The free size (in bytes) of the storage element.
  52
  53 getHost
  54 ^^^^^^^
  55
  56 .. java:method:: public native String getHost()
  57    :outertype: Storage
  58
  59    Returns the host name the storage is attached to
  60
  61    :return: the host name the storage is attached to
  62
  63 getName
  64 ^^^^^^^
  65
  66 .. java:method:: public String getName()
  67    :outertype: Storage
  68
  69    This method returns the name of a storage.
  70
  71    :return: The name of the storage.
  72
  73 getProperty
  74 ^^^^^^^^^^^
  75
  76 .. java:method:: public native String getProperty(String name)
  77    :outertype: Storage
  78
  79    Returns the value of a given storage property.
  80
  81 getSize
  82 ^^^^^^^
  83
  84 .. java:method:: public native long getSize()
  85    :outertype: Storage
  86
  87    This method returns the size (in bytes) of a storage element.
  88
  89    :return: The size (in bytes) of the storage element.
  90
  91 getUsedSize
  92 ^^^^^^^^^^^
  93
  94 .. java:method:: public native long getUsedSize()
  95    :outertype: Storage
  96
  97    This method returns the used size (in bytes) of a storage element.
  98
  99    :return: The used size (in bytes) of the storage element.
 100
 101 nativeInit
 102 ^^^^^^^^^^
 103
 104 .. java:method:: public static native void nativeInit()
 105    :outertype: Storage
 106
 107    Class initializer, to initialize various JNI stuff
 108
 109 setProperty
 110 ^^^^^^^^^^^
 111
 112 .. java:method:: public native void setProperty(String name, String value)
 113    :outertype: Storage
 114
 115    Change the value of a given storage property.
 116
 117 toString
 118 ^^^^^^^^
 119
 120 .. java:method:: @Override public String toString()
 121    :outertype: Storage
 122