com.barrybecker4.game.twoplayer.go.board.elements.GoSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bb4-go Show documentation

bb4-games java code.

There is a newer version: 1.6

/** Copyright by Barry G. Becker, 2000-2011. Licensed under MIT License: http://www.opensource.org/licenses/MIT  */
package com.barrybecker4.game.twoplayer.go.board.elements;

import java.util.Set;


/**
 *  A GoSet is an abstract class representing a set of go entities
 *  (stones, strings, groups, or armies)
 *
 *  @author Barry Becker
 */
public abstract class GoSet implements IGoSet {

    /** true if this set of stones is owned by player one (black)  */
    protected boolean ownedByPlayer1_;

    /**
     * constructor.
     */
    protected GoSet() {
        initializeMembers();
    }

    /**
     * @return  true if set is owned by player one
     */
    @Override
    public final boolean isOwnedByPlayer1() {
        return ownedByPlayer1_;
    }

    /**
     * @return  the number of stones in the set
     */
    @Override
    public final int size() {
        return getMembers().size();
    }

    /**
     * @return the hashSet containing the members
     */
    @Override
    public abstract Set getMembers();

    /**
     * Some initialization of the set members.
     */
    protected abstract void initializeMembers();

}