Package mpi
Class Info
- java.lang.Object
-
- mpi.Info
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Info
clone()
Java binding of the MPI operationMPI_INFO_DUP
.void
delete(java.lang.String key)
Java binding of the MPI operationMPI_INFO_DELETE
.Info
dup()
Java binding of the MPI operationMPI_INFO_DUP
.void
free()
Java binding of the MPI operationMPI_INFO_FREE
.java.lang.String
get(java.lang.String key)
Java binding of the MPI operationMPI_INFO_GET
.java.lang.String
getKey(int i)
Java binding of the MPI operationMPI_INFO_GET_NTHKEY
.boolean
isNull()
Tests if the info object isMPI_INFO_NULL
(has been freed).protected static Info
newEnv()
void
set(java.lang.String key, java.lang.String value)
Java binding of the MPI operationMPI_INFO_SET
.int
size()
Java binding of the MPI operationMPI_INFO_GET_NKEYS
.
-
-
-
Constructor Detail
-
Info
public Info() throws MPIException
Java binding of the MPI operationMPI_INFO_CREATE
.- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
Info
protected Info(long handle)
-
-
Method Detail
-
newEnv
protected static Info newEnv()
-
set
public void set(java.lang.String key, java.lang.String value) throws MPIException
Java binding of the MPI operationMPI_INFO_SET
.- Parameters:
key
- keyvalue
- value- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
get
public java.lang.String get(java.lang.String key) throws MPIException
Java binding of the MPI operationMPI_INFO_GET
.- Parameters:
key
- key- Returns:
- value or
null
if key is not defined - Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
delete
public void delete(java.lang.String key) throws MPIException
Java binding of the MPI operationMPI_INFO_DELETE
.- Parameters:
key
- key- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
size
public int size() throws MPIException
Java binding of the MPI operationMPI_INFO_GET_NKEYS
.- Returns:
- number of defined keys
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
getKey
public java.lang.String getKey(int i) throws MPIException
Java binding of the MPI operationMPI_INFO_GET_NTHKEY
.- Parameters:
i
- key number- Returns:
- key
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
clone
public Info clone()
Java binding of the MPI operationMPI_INFO_DUP
.It is recommended to use
dup()
instead ofclone()
because the last can't throw anMPIException
.- Overrides:
clone
in classjava.lang.Object
- Returns:
- info object
-
dup
public Info dup() throws MPIException
Java binding of the MPI operationMPI_INFO_DUP
.- Returns:
- info object
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
free
public void free() throws MPIException
Java binding of the MPI operationMPI_INFO_FREE
.- Specified by:
free
in interfaceFreeable
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
isNull
public boolean isNull()
Tests if the info object isMPI_INFO_NULL
(has been freed).- Returns:
- true if the info object is
MPI_INFO_NULL
, false otherwise.
-
-