/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package twitter4j;

import java.io.Serializable;

/**
 * @author Yusuke Yamamoto - yusuke at mac.com
 * @since Twitter4J 2.2.5
 */
public interface EntitySupport extends Serializable {
	/**
	 * Returns an array if hashtag mentioned in the tweet, or null if no hashtag
	 * were mentioned.
	 * 
	 * @return An array of Hashtag mentioned in the tweet.
	 * @since Twitter4J 2.1.9
	 */
	HashtagEntity[] getHashtagEntities();

	/**
	 * Returns an array of MediaEntities if media are available in the tweet,
	 * or null if no media is included in the tweet.
	 * 
	 * @return an array of MediaEntities.
	 * @since Twitter4J 2.2.3
	 */
	MediaEntity[] getMediaEntities();

	/**
	 * Returns an array if URLEntity mentioned in the tweet, or null if no URLs
	 * were mentioned.
	 * 
	 * @return An array of URLEntity mentioned in the tweet.
	 * @since Twitter4J 2.1.9
	 */
	URLEntity[] getURLEntities();

	/**
	 * Returns an array of user mentions in the tweet, or null if no users were
	 * mentioned.
	 * 
	 * @return An array of user mention entities in the tweet.
	 * @since Twitter4J 2.1.9
	 */
	UserMentionEntity[] getUserMentionEntities();
}