diff options
Diffstat (limited to 'org.eclipse.tips.core/src/org/eclipse/tips/core/Tip.java')
-rw-r--r-- | org.eclipse.tips.core/src/org/eclipse/tips/core/Tip.java | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/org.eclipse.tips.core/src/org/eclipse/tips/core/Tip.java b/org.eclipse.tips.core/src/org/eclipse/tips/core/Tip.java new file mode 100644 index 000000000..8d5cf112c --- /dev/null +++ b/org.eclipse.tips.core/src/org/eclipse/tips/core/Tip.java @@ -0,0 +1,109 @@ +/**************************************************************************** + * Copyright (c) 2017, 2018 Remain Software + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Wim Jongman <wim.jongman@remainsoftware.com> - initial API and implementation + *****************************************************************************/ +package org.eclipse.tips.core; + +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +/** + * This is the base Tip class of the UI agnostic Tip framework. You might want + * to check specializations of this class that may make your life easier. + * + */ +public abstract class Tip { + + private String providerId; + + private final List<TipAction> fActions = new ArrayList<>(); + + /** + * Constructor for a Tip. For the best user experience, Tips should be created + * really fast. + * + */ + public Tip(String providerId) { + this.providerId = providerId; + } + + /** + * For the sanity of the Framework, Tips should be created really fast. + * + * @param pProvider + * the associated {@link TipProvider} + * @param actions + * the list of actions which may not be null + */ + public Tip(List<TipAction> actions) { + fActions.addAll(actions); + } + + /** + * A getter for a list of {@link TipAction}s for this tip. Clients may override + * or provide the actions through the constructor. + * + * @return the list of actions, never null but could be empty. + */ + public List<TipAction> getActions() { + return fActions; + } + + /** + * Return the publish date of the tip. The UI could decide to server newer tips + * first. + * + * @return the date this tip was published which may not be null. + */ + public abstract Date getCreationDate(); + + + /** + * @return the subject which may not be null. + */ + public abstract String getSubject(); + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode()); + result = prime * result + ((providerId == null) ? 0 : providerId.hashCode()); + result = prime * result + ((getSubject() == null) ? 0 : getSubject().hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + Tip other = (Tip) obj; + if (getCreationDate() == null) { + if (other.getCreationDate() != null) + return false; + } else if (!getCreationDate().equals(other.getCreationDate())) + return false; + if (providerId == null) { + if (other.providerId != null) + return false; + } else if (!providerId.equals(other.providerId)) + return false; + if (getSubject() == null) { + if (other.getSubject() != null) + return false; + } else if (!getSubject().equals(other.getSubject())) + return false; + return true; + } +}
\ No newline at end of file |