GithubURLParser.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.plugin.github.factory.resolver;

/**
 * Interface for Gitlab repository URL parsers.
 *
 * @author Max Shaposhnik
 */
public interface GithubURLParser {

    /**
     * Check if the URL is a valid Github url for the given provider.
     *
     * @param url
     *         a not null string representation of URL
     * @return {@code true} if the URL is a valid url for the given provider.
     */
    boolean isValid(String url);

    /**
     * Provides a parsed URL object of the given provider type.
     *
     * @param url
     *         URL to transform into a managed object
     * @return managed url object
     */
    GithubUrl parse(String url);
}