- java.lang.Object
-
- com.ibm.jzos.DatasetVolumeList
-
public class DatasetVolumeList extends java.lang.Object
An object which maps the 265-byte workarea returned by the LOCATE macro, preceded by the 44-byte resolved dataset name.- Since:
- 2.1.0
- See Also:
ZFile.locateDSN(String, DatasetVolumeList)
-
-
Field Summary
Fields Modifier and Type Field Description static int
BUF_LEN
The buffer lengthstatic int
MAX_ENTRIES
The maximum number of volume entries
-
Constructor Summary
Constructors Constructor Description DatasetVolumeList()
Construct an instance
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
getBytes()
Answer the underlying byte array mapped by this object.int[]
getDeviceTypes()
Answer an array of ints, each containing the 4-byte device type of the corresponding volume entry.java.lang.String
getReturnedDSN()
Answer a String containing the DSN returned from the LOCATE macro.int
getTotalVolumesCount()
Answer the total number of volume entries found in the catalog.java.lang.String[]
getVolumes()
Answer a String array containing the volume serial numbers.
-
-
-
Field Detail
-
BUF_LEN
public static final int BUF_LEN
The buffer length- See Also:
- Constant Field Values
-
MAX_ENTRIES
public static final int MAX_ENTRIES
The maximum number of volume entries- See Also:
- Constant Field Values
-
-
Method Detail
-
getBytes
public byte[] getBytes()
Answer the underlying byte array mapped by this object.- Returns:
- byte[]
-
getTotalVolumesCount
public int getTotalVolumesCount()
Answer the total number of volume entries found in the catalog. Note that only the first 20 volume entries are actually returned by LOCATE/CAMLST in this object.
-
getDeviceTypes
public int[] getDeviceTypes()
Answer an array of ints, each containing the 4-byte device type of the corresponding volume entry. Only the first 20 entries are returned, up to the size given bygetTotalVolumesCount()
.- See Also:
getTotalVolumesCount()
-
getVolumes
public java.lang.String[] getVolumes()
Answer a String array containing the volume serial numbers. Only the first 20 volume names are returned, up to the size given bygetTotalVolumesCount()
.- See Also:
getTotalVolumesCount()
-
getReturnedDSN
public java.lang.String getReturnedDSN()
Answer a String containing the DSN returned from the LOCATE macro. This is generally the same as the input DSN, but in some circumstances, such as lookups of alias names or relative GDG names, it will return a different DSN.- Returns:
- String the DSN, with trailing blanks trimmed.
-
-