/* ============================================================================
(c) Copyright 2013 Hewlett-Packard Development Company, L.P.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge,publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
============================================================================ */

module.exports = Subdir;

/**
 * Representation of object seperators in paths as subdirectories.
 * 
 * @class Subdir
 * @constructor
 */
function Subdir(path, delimiter) {
  this._path = path;
  this._delimiter = delimiter;
}

/**
 * This is for a degree of transparency between Subdir and ObjectInfo objects.
 *
 * @method name
 */
Subdir.prototype.name = function () {
  return this._path;
};

/**
 * Alias of name().
 *
 * @method path
 */
Subdir.prototype.path = Subdir.prototype.name;

/**
 * The delimiter used as the directory seperator.
 *
 * @return {String} The delimiter used as the directory seperator.
 */
Subdir.prototype.delimiter = function () {
  return this._delimiter;
};