X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fbits%2FCell.java;h=f7b71a5f43a2b4cd8c1c1f8cc44bb54e5bae0948;hb=051e29138b18fb4b731a72f8727475b10e4c74e4;hp=f110d3362e6c61b3fe67ff94802d66afc57043c5;hpb=7b5261bc5b641e0769902f014e3b21f61050b02b;p=fanfix.git diff --git a/src/jexer/bits/Cell.java b/src/jexer/bits/Cell.java index f110d33..f7b71a5 100644 --- a/src/jexer/bits/Cell.java +++ b/src/jexer/bits/Cell.java @@ -1,29 +1,27 @@ -/** +/* * Jexer - Java Text User Interface * - * License: LGPLv3 or later - * - * 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. + * The MIT License (MIT) * - * Copyright (C) 2015 Kevin Lamonte + * Copyright (C) 2017 Kevin Lamonte * - * 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. + * 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: * - * 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. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * 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 + * 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. * * @author Kevin Lamonte [kevin.lamonte@gmail.com] * @version 1 @@ -33,19 +31,53 @@ package jexer.bits; /** * This class represents a single text cell on the screen. */ -public class Cell extends CellAttributes { +public final class Cell extends CellAttributes { + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** * The character at this cell. */ private char ch; + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Public constructor sets default values of the cell to blank. + * + * @see #isBlank() + * @see #reset() + */ + public Cell() { + reset(); + } + + /** + * Public constructor sets the character. Attributes are the same as + * default. + * + * @param ch character to set to + * @see #reset() + */ + public Cell(final char ch) { + reset(); + this.ch = ch; + } + + // ------------------------------------------------------------------------ + // Cell ------------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Getter for cell character. * * @return cell character */ - public final char getChar() { + public char getChar() { return ch; } @@ -54,7 +86,7 @@ public class Cell extends CellAttributes { * * @param ch new cell character */ - public final void setChar(final char ch) { + public void setChar(final char ch) { this.ch = ch; } @@ -62,7 +94,7 @@ public class Cell extends CellAttributes { * Reset this cell to a blank. */ @Override - public final void reset() { + public void reset() { super.reset(); ch = ' '; } @@ -74,14 +106,15 @@ public class Cell extends CellAttributes { * * @return true if this cell has default attributes. */ - public final boolean isBlank() { + public boolean isBlank() { if ((getForeColor().equals(Color.WHITE)) && (getBackColor().equals(Color.BLACK)) - && !getBold() - && !getBlink() - && !getReverse() - && !getUnderline() - && !getProtect() + && !isBold() + && !isBlink() + && !isReverse() + && !isUnderline() + && !isProtect() + && !isRGB() && (ch == ' ') ) { return true; @@ -97,14 +130,32 @@ public class Cell extends CellAttributes { * @return true if all fields are equal */ @Override - public final boolean equals(final Object rhs) { + public boolean equals(final Object rhs) { if (!(rhs instanceof Cell)) { return false; } Cell that = (Cell) rhs; - return (super.equals(rhs) - && (ch == that.ch)); + + if (ch == that.ch) { + return super.equals(rhs); + } + return false; + } + + /** + * Hashcode uses all fields in equals(). + * + * @return the hash + */ + @Override + public int hashCode() { + int A = 13; + int B = 23; + int hash = A; + hash = (B * hash) + super.hashCode(); + hash = (B * hash) + (int)ch; + return hash; } /** @@ -113,7 +164,7 @@ public class Cell extends CellAttributes { * @param rhs an instance of either Cell or CellAttributes */ @Override - public final void setTo(final Object rhs) { + public void setTo(final Object rhs) { // Let this throw a ClassCastException CellAttributes thatAttr = (CellAttributes) rhs; super.setTo(thatAttr); @@ -129,40 +180,18 @@ public class Cell extends CellAttributes { * * @param that a CellAttributes instance */ - public final void setAttr(final CellAttributes that) { + public void setAttr(final CellAttributes that) { super.setTo(that); } - /** - * Public constructor sets default values of the cell to blank. - * - * @see #isBlank() - * @see #reset() - */ - public Cell() { - reset(); - } - - /** - * Public constructor sets the character. Attributes are the same as - * default. - * - * @param ch character to set to - * @see #reset() - */ - public Cell(final char ch) { - reset(); - this.ch = ch; - } - /** * Make human-readable description of this Cell. * * @return displayable String */ @Override - public final String toString() { - return String.format("fore: %d back: %d bold: %s blink: %s ch %c", - getForeColor(), getBackColor(), getBold(), getBlink(), ch); + public String toString() { + return String.format("fore: %s back: %s bold: %s blink: %s ch %c", + getForeColor(), getBackColor(), isBold(), isBlink(), ch); } }