ResourceBuilderFactory.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.sling.resourcebuilder.api;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;

import aQute.bnd.annotation.ProviderType;

/**
 * Factory service for building {@link ResourceBuilder} instances.
 */
@ProviderType
public interface ResourceBuilderFactory {
    
    /** Start a ResourceBuilder using the supplied parent resource 
     *  @return the new builder
     * */
    ResourceBuilder forParent(Resource parent);
    
    /** Start a ResourceBuilder using the supplied ResourceResolver,
     *  starting with the root resource as the builder's parent resource. 
     *  @return the new builder
     * */
    ResourceBuilder forResolver(ResourceResolver r);
    
}