Package io.jhdf.api
Interface Link
-
- All Superinterfaces:
Node
- All Known Implementing Classes:
AbstractLink
,ExternalLink
,SoftLink
public interface Link extends Node
HDF5 links interface. Used for soft (symbolic) links and external links
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Node
getTarget()
Resolves the link and returns theNode
the link points to.java.lang.String
getTargetPath()
Gets the path this link points to, obtaining it will not require the link to be resolved.boolean
isBrokenLink()
Checks if the link is valid i.e can be resolved.-
Methods inherited from interface io.jhdf.api.Node
getAddress, getAttribute, getAttributes, getFile, getHdfFile, getName, getParent, getPath, getType, isAttributeCreationOrderTracked, isGroup, isLink
-
-
-
-
Method Detail
-
getTarget
Node getTarget()
Resolves the link and returns theNode
the link points to. IfisBrokenLink()
returnstrue
calling this method will throw.- Returns:
- the
Node
this link points to - Throws:
HdfBrokenLinkException
- if the link is broken
-
getTargetPath
java.lang.String getTargetPath()
Gets the path this link points to, obtaining it will not require the link to be resolved.- Returns:
- the path this link points to
-
isBrokenLink
boolean isBrokenLink()
Checks if the link is valid i.e can be resolved.- Returns:
true
if the link is broken (i.e. cannot be resolved)
-
-