org.raml.v2.internal.impl.commons.RamlHeader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of raml-parser-2 Show documentation
Raml parser implemented in java
There is a newer version: 1.0.51
/*
 * Copyright 2013 (c) MuleSoft, 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 org.raml.v2.internal.impl.commons;

import org.raml.v2.api.model.v10.RamlFragment;
import org.raml.v2.internal.impl.commons.nodes.TypeDeclarationNodeFragment;
import org.raml.v2.internal.impl.v08.grammar.Raml08Grammar;
import org.raml.v2.internal.impl.v10.grammar.Raml10Grammar;
import org.raml.v2.internal.utils.StreamUtils;
import org.raml.yagi.framework.grammar.rule.Rule;

import javax.annotation.Nullable;
import java.util.StringTokenizer;

import static org.raml.v2.internal.impl.commons.RamlVersion.RAML_08;
import static org.raml.v2.internal.impl.commons.RamlVersion.RAML_10;

public class RamlHeader
{

    public static final String RAML_HEADER_PREFIX = "#%RAML";

    private RamlVersion version;
    private RamlFragment fragment;

    public RamlHeader(RamlVersion version, RamlFragment fragment)
    {
        this.version = version;
        this.fragment = fragment;
    }

    public RamlHeader(RamlVersion version)
    {
        this(version, null);
    }

    public static RamlHeader parse(String stringContent) throws InvalidHeaderException
    {
        final StringTokenizer lines = new StringTokenizer(StreamUtils.trimBom(stringContent), "\n");
        if (lines.hasMoreElements())
        {
            final String header = lines.nextToken().trim();
            final StringTokenizer headerParts = new StringTokenizer(header);
            if (headerParts.hasMoreTokens())
            {
                final String raml = headerParts.nextToken();
                if (RAML_HEADER_PREFIX.equals(raml))
                {
                    if (headerParts.hasMoreTokens())
                    {
                        String stringVersion = headerParts.nextToken();
                        RamlVersion version;
                        try
                        {
                            version = RamlVersion.parse(stringVersion);
                        }
                        catch (IllegalArgumentException e)
                        {
                            throw new InvalidHeaderVersionException(stringVersion);
                        }
                        if (version == RAML_10)
                        {
                            final String fragmentText = headerParts.hasMoreTokens() ? headerParts.nextToken() : "";
                            RamlFragment fragment = RamlFragment.byName(fragmentText);
                            if (fragment == null)
                            {
                                throw new InvalidHeaderFragmentException(fragmentText);
                            }
                            return new RamlHeader(RAML_10, fragment);
                        }
                        return new RamlHeader(RAML_08);
                    }
                }
            }
            throw new InvalidHeaderException(header);
        }
        else
        {
            throw new MissingHeaderException();
        }
    }

    public RamlVersion getVersion()
    {
        return version;
    }

    @Nullable
    public RamlFragment getFragment()
    {
        return fragment;
    }

    @Nullable
    public Rule getRule()
    {
        if (getVersion() == RamlVersion.RAML_08)
        {
            return new Raml08Grammar().raml();
        }
        return getFragmentRule(fragment);
    }

    @Nullable
    public static Rule getFragmentRule(RamlFragment fragment)
    {
        Raml10Grammar grammar = new Raml10Grammar();
        switch (fragment)
        {
        case DocumentationItem:
            return grammar.documentation()
                          .with(0, grammar.usesField());
        case DataType:
            return grammar.explicitType().with(0, grammar.usesField()).then(TypeDeclarationNodeFragment.class);
        case NamedExample:
            return grammar.exampleFragment();
        case ResourceType:
            return grammar.resourceType().with(0, grammar.usesField());
        case Trait:
            return grammar.trait().with(0, grammar.usesField());
        case AnnotationTypeDeclaration:
            return grammar.annotationTypeDeclaration().with(0, grammar.usesField());
        case Library:
            return grammar.libraryValue();
        case Overlay:
        case Extension:
            return grammar.extension();
        case SecurityScheme:
            return grammar.securityScheme().with(0, grammar.usesField());
        case Default:
            return grammar.raml();
        default:
            return null;
        }
    }

    @Override
    public String toString()
    {
        return RAML_HEADER_PREFIX + " " + version.value() + (fragment != null ? (" " + fragment) : "");
    }

    public static class InvalidHeaderException extends Exception
    {

        public InvalidHeaderException()
        {
        }

        public InvalidHeaderException(String message)
        {
            super(message);
        }
    }

    public static class InvalidHeaderFragmentException extends InvalidHeaderException
    {

        public InvalidHeaderFragmentException(String fragmentText)
        {
            super(fragmentText);
        }
    }

    public static class InvalidHeaderVersionException extends InvalidHeaderException
    {

        public InvalidHeaderVersionException(String version)
        {
            super(version);
        }
    }

    public static class MissingHeaderException extends InvalidHeaderException
    {

    }
}