X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fbits%2FCell.java;h=d4d78ba3ab25b4446eaed222796a055e7fd82a94;hb=e16dda65585466c8987bd1efd718431450a96605;hp=537b2a6f7972149e982d14f2b0b4f2038d6f4d51;hpb=624ce48ecf9a314771bd8f1616d8035b0253d8a0;p=nikiroo-utils.git diff --git a/src/jexer/bits/Cell.java b/src/jexer/bits/Cell.java index 537b2a6..d4d78ba 100644 --- a/src/jexer/bits/Cell.java +++ b/src/jexer/bits/Cell.java @@ -1,133 +1,181 @@ -/** +/* * Jexer - Java Text User Interface * - * Version: $Id$ - * - * Author: Kevin Lamonte, kevin.lamonte@gmail.com + * The MIT License (MIT) * - * License: LGPLv3 or later + * Copyright (C) 2016 Kevin Lamonte * - * Copyright: This module is licensed under the GNU Lesser General - * Public License Version 3. Please see the file "COPYING" in this - * directory for more information about the GNU Lesser General Public - * License Version 3. + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: * - * Copyright (C) 2015 Kevin Lamonte + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 3 of - * the License, or (at your option) any later version. + * THE 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 SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. * - * This program 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 Lesser General Public - * License along with this program; if not, see - * http://www.gnu.org/licenses/, or write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA + * @author Kevin Lamonte [kevin.lamonte@gmail.com] + * @version 1 */ package jexer.bits; /** - * A single text cell on the screen + * This class represents a single text cell on the screen. */ -public class Cell extends CellAttributes { +public final class Cell extends CellAttributes { /** - * The character at this cell + * The character at this cell. */ - public char ch; + private char ch; /** - * Reset this cell to a blank + * Getter for cell character. + * + * @return cell character + */ + public char getChar() { + return ch; + } + + /** + * Setter for cell character. + * + * @param ch new cell character + */ + public void setChar(final char ch) { + this.ch = ch; + } + + /** + * Reset this cell to a blank. */ @Override public void reset() { - super.reset(); - ch = ' '; + super.reset(); + ch = ' '; } /** - * Returns true if this cell has default attributes + * Check to see if this cell has default attributes: white foreground, + * black background, no bold/blink/reverse/underline/protect, and a + * character value of ' ' (space). + * + * @return true if this cell has default attributes. */ public boolean isBlank() { - if ((foreColor.equals(Color.WHITE)) && - (backColor.equals(Color.BLACK)) && - (bold == false) && - (blink == false) && - (reverse == false) && - (underline == false) && - (protect == false) && - (ch == ' ')) { - return true; - } - - return false; + if ((getForeColor().equals(Color.WHITE)) + && (getBackColor().equals(Color.BLACK)) + && !isBold() + && !isBlink() + && !isReverse() + && !isUnderline() + && !isProtect() + && (ch == ' ') + ) { + return true; + } + + return false; } /** - * Comparison. All fields must match to return true. + * Comparison check. All fields must match to return true. + * + * @param rhs another Cell instance + * @return true if all fields are equal + */ + @Override + public boolean equals(final Object rhs) { + if (!(rhs instanceof Cell)) { + return false; + } + + Cell that = (Cell) rhs; + return (super.equals(rhs) + && (ch == that.ch)); + } + + /** + * Hashcode uses all fields in equals(). + * + * @return the hash */ @Override - public boolean equals(Object rhs) { - if (!(rhs instanceof Cell)) { - return false; - } - - Cell that = (Cell)rhs; - return (super.equals(rhs) && - (ch == that.ch)); + public int hashCode() { + int A = 13; + int B = 23; + int hash = A; + hash = (B * hash) + super.hashCode(); + hash = (B * hash) + (int)ch; + return hash; } /** - * Set my field values to that's field + * Set my field values to that's field. + * + * @param rhs an instance of either Cell or CellAttributes */ @Override - public void setTo(Object rhs) { - CellAttributes thatAttr = (CellAttributes)rhs; - super.setTo(thatAttr); - - if (rhs instanceof Cell) { - Cell that = (Cell)rhs; - this.ch = that.ch; - } + public void setTo(final Object rhs) { + // Let this throw a ClassCastException + CellAttributes thatAttr = (CellAttributes) rhs; + super.setTo(thatAttr); + + if (rhs instanceof Cell) { + Cell that = (Cell) rhs; + this.ch = that.ch; + } } /** - * Set my field attr values to that's field + * Set my field attr values to that's field. + * + * @param that a CellAttributes instance */ - public void setAttr(CellAttributes that) { - super.setTo(that); + public void setAttr(final CellAttributes that) { + super.setTo(that); } /** - * Public constructor + * Public constructor sets default values of the cell to blank. + * + * @see #isBlank() + * @see #reset() */ public Cell() { - reset(); + reset(); } /** - * Public constructor + * Public constructor sets the character. Attributes are the same as + * default. * * @param ch character to set to + * @see #reset() */ - public Cell(char ch) { - reset(); - this.ch = ch; + public Cell(final char ch) { + reset(); + this.ch = ch; } /** - * Make human-readable description of this Cell + * Make human-readable description of this Cell. + * + * @return displayable String */ @Override public String toString() { - return String.format("fore: %d back: %d bold: %s blink: %s ch %c", - foreColor, backColor, bold, blink, ch); + return String.format("fore: %d back: %d bold: %s blink: %s ch %c", + getForeColor(), getBackColor(), isBold(), isBlink(), ch); } } -