AncestorLinksRenderer.java

/*
 * Copyright (C) 2009 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.sites.liberation.renderers;

import com.google.gdata.data.sites.BasePageEntry;
import com.google.inject.ImplementedBy;
import com.google.sites.liberation.util.XmlElement;

import java.util.List;

/**
 * Renders the links to a page's ancestors.
 * 
 * @author bsimon@google.com (Benjamin Simon)
 */
@ImplementedBy(AncestorLinksRendererImpl.class)
public interface AncestorLinksRenderer {

  /** 
   * Returns an XmlElement containing links to an entry's ancestors. The
   * given list of ancestors should have the entry's parent as the last item,
   * parent's parent as the second to last item, and so on.
   */
  XmlElement renderAncestorLinks(List<BasePageEntry<?>> ancestors);
}