/*
 * Copyright (c) 2017, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 * WSO2 Inc. 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.wso2.carbon.uis.api;

import org.wso2.carbon.uis.api.exception.RenderingException;
import org.wso2.carbon.uis.api.http.HttpRequest;

import java.util.Objects;

/**
 * Represents a page of a web app.
 *
 * @since 0.8.0
 */
public abstract class Page implements Comparable<Page> {

    private final UriPatten uriPatten;

    /**
     * Creates a new page.
     *
     * @param uriPatten URI pattern of the page
     */
    public Page(UriPatten uriPatten) {
        this.uriPatten = uriPatten;
    }

    /**
     * Returns the URI pattern of this page.
     *
     * @return URI pattern of this page
     */
    public UriPatten getUriPatten() {
        return uriPatten;
    }

    /**
     * Checks whether this page matches to the given URI.
     *
     * @param uri URI to be matched
     * @return {@code true} iff matches, otherwise {@code false}
     */
    public boolean matches(String uri) {
        return uriPatten.matches(uri);
    }

    /**
     * Renders this page and returns a HTML document.
     *
     *
     * @param request
     * @param configuration
     * @return html
     * @throws RenderingException if an error occurred during page rendering
     */
    public abstract String render(HttpRequest request, Configuration configuration) throws RenderingException;

    @Override
    public int compareTo(Page otherPage) {
        return (otherPage == null) ? 1 : this.uriPatten.compareTo(otherPage.uriPatten);
    }

    @Override
    public boolean equals(Object obj) {
        return (this == obj) || ((obj instanceof Page) && (this.compareTo((Page) obj) == 0));
    }

    @Override
    public int hashCode() {
        return Objects.hash(uriPatten);
    }

    @Override
    public String toString() {
        return "Page{uriPatten=" + uriPatten + "}";
    }
}

@@ -1702,30 +1702,36 @@
 *%0A     *
-%0A     *
  @param
+ request HTTP
  request
@@ -1762,28 +1762,79 @@
 tion
-%0A     * @return html
+ configurations of the app%0A     * @return output html of page rendering
 %0A   

improve javadoc in Page class