001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2021, 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 * FlowEntity.java 029 * --------------- 030 * (C) Copyright 2021, by Object Refinery Limited and Contributors. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 */ 036 037package org.jfree.chart.entity; 038 039import java.awt.Shape; 040import java.util.Objects; 041import org.jfree.chart.plot.flow.FlowPlot; 042import org.jfree.chart.util.Args; 043import org.jfree.data.flow.FlowKey; 044 045/** 046 * A chart entity representing the flow between two nodes in a {@link FlowPlot}. 047 * 048 * @since 1.5.3 049 */ 050public class FlowEntity extends ChartEntity { 051 052 private FlowKey key; 053 054 /** 055 * Creates a new instance. 056 * 057 * @param key the key identifying the flow ({@code null} not permitted). 058 * @param area the outline of the entity ({@code null} not permitted). 059 * @param toolTipText the tool tip text. 060 * @param urlText the URL text. 061 */ 062 public FlowEntity(FlowKey key, Shape area, String toolTipText, String urlText) { 063 super(area, toolTipText, urlText); 064 Args.nullNotPermitted(key, "key"); 065 this.key = key; 066 } 067 068 /** 069 * Returns the key identifying the flow. 070 * 071 * @return The flow key (never {@code null}). 072 */ 073 public FlowKey getKey() { 074 return this.key; 075 } 076 077 /** 078 * Returns a string representation of this instance, primarily for 079 * debugging purposes. 080 * 081 * @return A string. 082 */ 083 @Override 084 public String toString() { 085 return "[FlowEntity: " + this.key + "]"; 086 } 087 088 /** 089 * Tests this instance for equality with an arbitrary object. 090 * 091 * @param obj the object ({@code null} permitted). 092 * 093 * @return A boolean. 094 */ 095 @Override 096 public boolean equals(Object obj) { 097 if (!(obj instanceof FlowEntity)) { 098 return false; 099 } 100 FlowEntity that = (FlowEntity) obj; 101 if (!this.key.equals(that.key)) { 102 return false; 103 } 104 return super.equals(obj); 105 } 106 107 @Override 108 public int hashCode() { 109 int hash = 7; 110 hash = 79 * hash + Objects.hashCode(this.key); 111 return hash; 112 } 113 114}