// @formatter:off
/*
 * Pexel Project - Minecraft minigame server platform. 
 * Copyright (C) 2014 Matej Kormuth <http://www.matejkormuth.eu>
 * 
 * This file is part of Pexel.
 * 
 * Pexel is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * 
 * Pexel is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 *
 */
// @formatter:on
package eu.matejkormuth.pexel.PexelCore.util;

import org.apache.commons.lang.Validate;

/**
 * Location on server. Used for unknown pruposes.
 * 
 * @author Mato Kormuth
 * 
 */
public class ServerLocation {
    /**
     * Name of the location.
     */
    private final String             locationName;
    /**
     * Type of the location.
     */
    private final ServerLocationType locationType;
    
    /**
     * Creates new instance of ServerLocation.
     * 
     * @param locationName
     * @param locationType
     */
    public ServerLocation(final String locationName,
            final ServerLocationType locationType) {
        Validate.notNull(locationName);
        Validate.notNull(locationType);
        
        this.locationName = locationName;
        this.locationType = locationType;
    }
    
    /**
     * Returns name of server location.
     * 
     * @return the name
     */
    public String getName() {
        return this.locationName;
    }
    
    /**
     * Returns type of location.
     * 
     * @return type
     */
    public ServerLocationType getType() {
        return this.locationType;
    }
    
    @Override
    public String toString() {
        return this.locationType.toString() + ": " + this.locationName;
    }
}
