001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * ----------------------- 028 * KeyedValuesItemKey.java 029 * ----------------------- 030 * (C) Copyright 2014, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes: 036 * -------- 037 * 18-Aug-2014 : Version 1, based on code from Orson Charts (DG); 038 * 039 */ 040 041package org.jfree.data; 042 043import java.io.Serializable; 044import org.jfree.chart.util.Args; 045 046public class KeyedValuesItemKey implements ItemKey, Serializable { 047 048 /** The key for the item. */ 049 Comparable<? extends Object> key; 050 051 /** 052 * Creates a new instance. 053 * 054 * @param key the key ({@code null} not permitted). 055 */ 056 public KeyedValuesItemKey(Comparable<? extends Object> key) { 057 Args.nullNotPermitted(key, "key"); 058 this.key = key; 059 } 060 061 /** 062 * Returns the key. 063 * 064 * @return The key (never {@code null}). 065 */ 066 public Comparable<?> getKey() { 067 return this.key; 068 } 069 070 /** 071 * Tests this instance for equality with an arbitrary object. 072 * 073 * @param obj the object ({@code null} not permitted). 074 * 075 * @return A boolean. 076 */ 077 @Override 078 public boolean equals(Object obj) { 079 if (obj == this) { 080 return true; 081 } 082 if (!(obj instanceof KeyedValuesItemKey)) { 083 return false; 084 } 085 KeyedValuesItemKey that = (KeyedValuesItemKey) obj; 086 if (!this.key.equals(that.key)) { 087 return false; 088 } 089 return true; 090 } 091 092 @Override 093 public String toJSONString() { 094 StringBuilder sb = new StringBuilder(); 095 sb.append("{\"key\": \"").append(this.key.toString()).append("\"}"); 096 return sb.toString(); 097 } 098 099 @Override 100 public String toString() { 101 StringBuilder sb = new StringBuilder(); 102 sb.append("KeyedValuesItemKey["); 103 sb.append(this.key.toString()); 104 sb.append("]"); 105 return sb.toString(); 106 } 107}