001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.repository.root;
017
018import javax.jcr.Node;
019
020import org.ametys.plugins.repository.AmetysObject;
021import org.ametys.plugins.repository.AmetysRepositoryException;
022import org.ametys.plugins.repository.jcr.DefaultTraversableAmetysObject;
023
024/**
025 * {@link AmetysObject} representing the root of the Ametys hierarchy.<br>
026 * It's name and path are equals to the empty {@link String}.<br>
027 * It has no parent object.
028 */
029public final class RootAmetysObject extends DefaultTraversableAmetysObject<RootAmetysObjectFactory>
030{
031    /**
032     * Creates a {@link RootAmetysObject}.
033     * @param node the corresponding JCR node.
034     * @param factory the {@link RootAmetysObjectFactory} which creates the AmetysObject.
035     */
036    public RootAmetysObject(Node node, RootAmetysObjectFactory factory)
037    {
038        super(node, "", factory);
039    }
040
041    @Override
042    public String getPath()
043    {
044        return "";
045    }
046    
047    @Override
048    public String getName() throws AmetysRepositoryException
049    {
050        return "";
051    }
052    
053    @Override
054    public <A extends AmetysObject> A getParent() throws AmetysRepositoryException
055    {
056        return null;
057    }
058}