Attachment #193927 for bug #343602

View | Details | Raw Unified | Return to bug 343602 | Differences between
Collapse All | Expand All




/*******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  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:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *******************************************************************************/
package org.eclipse.mylyn.commons.identity.gravatar;

/**
 * Base implementation of {@link IGravatarCallback}
 * 
 * @author Kevin Sawicki (kevin@github.com)
 */
public abstract class GravatarCallbackAdapter implements IGravatarCallback {

	/**
	 * @see org.eclipse.mylyn.commons.identity.gravatar.IGravatarCallback#loaded(org.eclipse.mylyn.commons.identity.gravatar.Gravatar)
	 */
	public void loaded(Gravatar avatar) {
		// Does nothing sub-clsases should override
	}

	/**
	 * @see org.eclipse.mylyn.commons.identity.gravatar.IGravatarCallback#error(java.lang.Exception)
	 */
	public void error(Exception exception) {
		// Does nothing sub-clsases should override
	}

}




/*******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  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:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.commons.identity.gravatar;

/**
 * Callback interface for when gravatar loading completes or fails.
 * 
 * @author Kevin Sawicki (kevin@github.com)
 */
public interface IGravatarCallback {

	/**
	 * Gravatar loaded successfully
	 * 
	 * @param avatar
	 */
	void loaded(Gravatar avatar);

	/**
	 * Gravatar loading failed
	 * 
	 * @param exception
	 */
	void error(Exception exception);

}




/*******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  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:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.commons.identity.gravatar;

/**
 * Interface for providing a gravatar hash.
 * 
 * @author Kevin Sawicki (kevin@github.com)
 */
public interface IGravatarHashProvider {

	/**
	 * Get hash for gravatar lookup
	 * 
	 * @return gravatar hash
	 */
	String getGravatarHash();

}




/*******************************************************************************
 *  Copyright (c) 2011 Kevin Sawicki
 *  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
 *  
 *******************************************************************************/
package org.eclipse.mylyn.commons.identity.gravatar;

import java.io.IOException;

import org.eclipse.core.runtime.IProgressMonitor;

/**
 * Gravatar store interface.
 * 
 * @author Kevin Sawicki (kevin@github.com)
 */
public interface IGravatarStore {

	/**
	 * Does this store contain a gravatar for the specified hash?
	 * 
	 * @param hash
	 * @return true if store contains avatar, false otherwise
	 */
	boolean containsGravatar(String hash);

	/**
	 * Refresh all gravatars currently in the store
	 * 
	 * @param monitor
	 * @return this store
	 */
	IGravatarStore refresh(IProgressMonitor monitor);

	/**
	 * Schedule refresh of gravatars asynchronously
	 * 
	 * @return this store
	 */
	IGravatarStore scheduleRefresh();

	/**
	 * Get last refresh time of store
	 * 
	 * @return local refresh time
	 */
	long getRefreshTime();

	/**
	 * Load gravatar by hash asynchronously
	 * 
	 * @param hash
	 * @param callback
	 * @return this store
	 */
	IGravatarStore loadGravatarByHash(String hash, IGravatarCallback callback);

	/**
	 * Load latest gravatar by specified hash
	 * 
	 * @param hash
	 * @return avatar or null if load fails
	 * @throws IOException
	 */
	Gravatar loadGravatarByHash(String hash) throws IOException;

	/**
	 * Load gravatar by e-mail address asynchronously
	 * 
	 * @param email
	 * @param callback
	 * @return this store
	 */
	IGravatarStore loadGravatarByEmail(String email, IGravatarCallback callback);

	/**
	 * Load latest gravatar for specified e-mail address
	 * 
	 * @param email
	 * @return gravatar or null if load fails
	 * @throws IOException
	 */
	Gravatar loadGravatarByEmail(String email) throws IOException;

	/**
	 * Get cached gravatar by hash
	 * 
	 * @param hash
	 * @return gravatar or null if not in cache
	 */
	Gravatar getGravatarByHash(String hash);

	/**
	 * Get cached gravatar by e-mail address
	 * 
	 * @param email
	 * @return gravatar or null if not in cache
	 */
	Gravatar getGravatarByEmail(String email);

}

Return to bug 343602

Added Link Here

(-)src/org/eclipse/mylyn/commons/identity/gravatar/GravatarCallbackAdapter.java (+34 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 GitHub Inc.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Kevin Sawicki (GitHub Inc.) - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.mylyn.commons.identity.gravatar;
12
13	/**
14	* Base implementation of {@link IGravatarCallback}
15	*
16	* @author Kevin Sawicki (kevin@github.com)
17	*/
18	public abstract class GravatarCallbackAdapter implements IGravatarCallback {
19
20	/**
21	* @see org.eclipse.mylyn.commons.identity.gravatar.IGravatarCallback#loaded(org.eclipse.mylyn.commons.identity.gravatar.Gravatar)
22	*/
23	public void loaded(Gravatar avatar) {
24	// Does nothing sub-clsases should override
25	}
26
27	/**
28	* @see org.eclipse.mylyn.commons.identity.gravatar.IGravatarCallback#error(java.lang.Exception)
29	*/
30	public void error(Exception exception) {
31	// Does nothing sub-clsases should override
32	}
33
34	}

Added Link Here

(-)src/org/eclipse/mylyn/commons/identity/gravatar/IGravatarStore.java (+104 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 Kevin Sawicki
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	*******************************************************************************/
9	package org.eclipse.mylyn.commons.identity.gravatar;
10
11	import java.io.IOException;
12
13	import org.eclipse.core.runtime.IProgressMonitor;
14
15	/**
16	* Gravatar store interface.
17	*
18	* @author Kevin Sawicki (kevin@github.com)
19	*/
20	public interface IGravatarStore {
21
22	/**
23	* Does this store contain a gravatar for the specified hash?
24	*
25	* @param hash
26	* @return true if store contains avatar, false otherwise
27	*/
28	boolean containsGravatar(String hash);
29
30	/**
31	* Refresh all gravatars currently in the store
32	*
33	* @param monitor
34	* @return this store
35	*/
36	IGravatarStore refresh(IProgressMonitor monitor);
37
38	/**
39	* Schedule refresh of gravatars asynchronously
40	*
41	* @return this store
42	*/
43	IGravatarStore scheduleRefresh();
44
45	/**
46	* Get last refresh time of store
47	*
48	* @return local refresh time
49	*/
50	long getRefreshTime();
51
52	/**
53	* Load gravatar by hash asynchronously
54	*
55	* @param hash
56	* @param callback
57	* @return this store
58	*/
59	IGravatarStore loadGravatarByHash(String hash, IGravatarCallback callback);
60
61	/**
62	* Load latest gravatar by specified hash
63	*
64	* @param hash
65	* @return avatar or null if load fails
66	* @throws IOException
67	*/
68	Gravatar loadGravatarByHash(String hash) throws IOException;
69
70	/**
71	* Load gravatar by e-mail address asynchronously
72	*
73	* @param email
74	* @param callback
75	* @return this store
76	*/
77	IGravatarStore loadGravatarByEmail(String email, IGravatarCallback callback);
78
79	/**
80	* Load latest gravatar for specified e-mail address
81	*
82	* @param email
83	* @return gravatar or null if load fails
84	* @throws IOException
85	*/
86	Gravatar loadGravatarByEmail(String email) throws IOException;
87
88	/**
89	* Get cached gravatar by hash
90	*
91	* @param hash
92	* @return gravatar or null if not in cache
93	*/
94	Gravatar getGravatarByHash(String hash);
95
96	/**
97	* Get cached gravatar by e-mail address
98	*
99	* @param email
100	* @return gravatar or null if not in cache
101	*/
102	Gravatar getGravatarByEmail(String email);
103
104	}