Project: stp

javax.wvcm
Interface Location

All Known Subinterfaces:
CcLocation, StpLocation

public interface Location

The location of a resource.

The format of the location string is specific to the repository that stores the persistent resource. A URL, a UNC filename, and an NFS filename are examples of possible formats for a location string. Locations are constructed by the Provider.location(java.lang.String) method.

All methods in this interface are implemented in-memory only, i.e., no access to the repository is required.

Since:
1.0

Method Summary
 Location child(String bindingName)
          Return the location of the bound member with the specified bindingName in the folder at this Location.
 String lastSegment()
          Get the last segment of this Location.
 Location parent()
          Return the location of a folder that has the resource at this Location as a bound member whose binding name is the lastSegment of this Location.
 String string()
          Return a string value for this Location.
 

Method Detail

child

Location child(String bindingName)
               throws WvcmException
Return the location of the bound member with the specified bindingName in the folder at this Location.

Parameters:
bindingName - the name of the bound member. The last segment of the returned location must be bindingName. The bindingName commonly is not allowed to contain the "/" character.
Returns:
the location of the bound member with the specified binding name in the folder at this Location.
Throws:
WvcmException - if this Location is not one that can have bound members, or if the bindingName is not syntactically valid.

lastSegment

String lastSegment()
Get the last segment of this Location. If the parent() is null, the lastSegment() is null. In general, if loc is a Location that has a parent, loc.parent().child(loc.lastSegment()).equals(loc).

Returns:
the last segment of this Location. Commonly, this is the portion following the last "/" in the string value of this Location.

parent

Location parent()
Return the location of a folder that has the resource at this Location as a bound member whose binding name is the lastSegment of this Location.

Returns:
the location of a folder that has the resource at this Location as a bound member whose binding name is the lastSegment of this Location. If this Location has no parent, null is returned.

string

String string()
Return a string value for this Location. The Provider.location(java.lang.String) method is the inverse of this method, i.e., location.equals(Provider.location(location.string())).

Returns:
a string value for this Location.

Generated Wed 14-Mar-2018 10:38 PM

Copyright © IBM 2018. All rights reserved.