package votorola.a.position; // Copyright 2009-2013, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import java.io.*;
import votorola.g.lang.*;


/** An identifier of a position.
  *
  *     @see <a href='http://reluk.ca/w/Category:Position'
  *                        target='_top'>Category:Position</a>
  */
public @ThreadSafe class PositionID implements Serializable // where serialized?  PositionalRevisions
{


    /** Constructs a PositionID.
      */
    public PositionID( String _personName, String _pollName )
    {
        personName = _personName;
        pollName = _pollName;
    }



   // ------------------------------------------------------------------------------------


    /** Returns the page name in the pollwiki of the specified position.
      *
      *     @param pollName this is ignored if the named person is actually a pipe.
      *
      *     @see votorola.a.Pollwiki#positionPageName(String,String)
      */
    public static String pageName( final String personName, final String pollName,
      final PipeRecognizer pipeRecognizer )
    {
        final StringBuilder b = new StringBuilder();
        b.append( "User:" ).append( personName );
        if( !pipeRecognizer.isPipeName( personName )) b.append( '/' ).append( pollName );
        return b.toString();
    }



    /** The username of the person.
      */
    public final String personName() { return personName; }


        private final String personName;



    /** The name of the poll.
      */
    public final String pollName() { return pollName; }


        private final String pollName;


}