com.phoenixnap.oss.ramlapisync.raml.RamlResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of springmvc-raml-parser Show documentation

Components including the parsing of RAML documents and Spring MVC Annotations to create RAML models

The newest version!

/*
 * Copyright 2002-2017 the original author or authors.
 * 
 * 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.phoenixnap.oss.ramlapisync.raml;


import java.util.Map;

/**
 * Abstract Representation of a Raml Resource
 * 
 * @author armin.weisser
 * @since 0.8.1
 */
public interface RamlResource extends RamlResourceRoot {

    String getRelativeUri();

    Map getActions();

    Map getUriParameters();

    void addUriParameter(String name, RamlUriParameter uriParameter);

    Map getResolvedUriParameters();

    String getUri();

    String getDescription();
    
    String getDisplayName();

    RamlResource getParentResource();

    void setParentResource(RamlResource parentResource);

    String getParentUri();

    void setParentUri(String parentUri);

    void setRelativeUri(String relativeUri);

    void setDisplayName(String displayName);

    void setDescription(String description);

    RamlAction getAction(RamlActionType actionType);

    void addAction(RamlActionType apiAction, RamlAction action);

    void addActions(Map actions);
}