PageRange.java revision c43639c3067dda5df189fb3cbf14f256c17e677d
14b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov/* 24b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Copyright (C) 2013 The Android Open Source Project 34b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 44b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Licensed under the Apache License, Version 2.0 (the "License"); 54b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * you may not use this file except in compliance with the License. 64b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * You may obtain a copy of the License at 74b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 84b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * http://www.apache.org/licenses/LICENSE-2.0 94b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 104b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Unless required by applicable law or agreed to in writing, software 114b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * distributed under the License is distributed on an "AS IS" BASIS, 124b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 134b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * See the License for the specific language governing permissions and 144b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * limitations under the License. 154b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 164b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 174b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganovpackage android.print; 184b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 19c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmannimport android.annotation.IntRange; 20c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmannimport android.annotation.NonNull; 214b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganovimport android.os.Parcel; 224b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganovimport android.os.Parcelable; 234b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 244b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov/** 254b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Represents a range of pages. The start and end page indices of 26fd90651cfcc7e2b75254666fd6861038b72fb4acSvetoslav * the range are zero based and inclusive. 274b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 284b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganovpublic final class PageRange implements Parcelable { 294b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 304b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov /** 314b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Constant for specifying all pages. 324b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 334b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public static final PageRange ALL_PAGES = new PageRange(0, Integer.MAX_VALUE); 344b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 354b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov private final int mStart; 364b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov private final int mEnd; 374b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 384b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov /** 394b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Creates a new instance. 404b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 414b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * @param start The start page index (zero based and inclusive). 424b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * @param end The end page index (zero based and inclusive). 434b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 444d4c66dd38e940082e385b49a33f4022ab04c738Svetoslav Ganov * @throws IllegalArgumentException If start is less than zero or end 454d4c66dd38e940082e385b49a33f4022ab04c738Svetoslav Ganov * is less than zero or start greater than end. 464b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 47c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmann public PageRange(@IntRange(from = 0) int start, @IntRange(from = 0) int end) { 484b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov if (start < 0) { 494b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov throw new IllegalArgumentException("start cannot be less than zero."); 504b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 514b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov if (end < 0) { 524b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov throw new IllegalArgumentException("end cannot be less than zero."); 534b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 544b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov if (start > end) { 554b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov throw new IllegalArgumentException("start must be lesser than end."); 564b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 574b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov mStart = start; 584b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov mEnd = end; 594b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 604b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 61c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmann private PageRange(@NonNull Parcel parcel) { 624b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov this(parcel.readInt(), parcel.readInt()); 634b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 644b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 654b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov /** 664b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Gets the start page index (zero based and inclusive). 674b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 684b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * @return The start page index. 694b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 70c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmann public @IntRange(from = 0) int getStart() { 714b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return mStart; 724b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 734b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 744b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov /** 754b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * Gets the end page index (zero based and inclusive). 764b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * 774b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov * @return The end page index. 784b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov */ 79c43639c3067dda5df189fb3cbf14f256c17e677dPhilip P. Moltmann public @IntRange(from = 0) int getEnd() { 804b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return mEnd; 814b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 824b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 83525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov /** 84525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * Gets whether a page range contains a a given page. 85525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * 86525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * @param pageIndex The page index. 87525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * @return True if the page is within this range. 88525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * 89525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * @hide 90525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov */ 91525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov public boolean contains(int pageIndex) { 9215cbc8a03250eafdf947cd8ad4e77f34444d5ba4Svetoslav return (pageIndex >= mStart) && (pageIndex <= mEnd); 93525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov } 94525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov 95525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov /** 96525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * Get the size of this range which is the number of 97525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * pages it contains. 98525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * 99525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * @return The size of the range. 100525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * 101525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov * @hide 102525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov */ 103525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov public int getSize() { 104525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov return mEnd - mStart + 1; 105525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov } 106525a66b2bb5abf844aff2109bdc9ed819566beceSvet Ganov 1074b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov @Override 1084b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public int describeContents() { 1094b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return 0; 1104b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1114b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 1124b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov @Override 1134b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public void writeToParcel(Parcel parcel, int flags) { 1144b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov parcel.writeInt(mStart); 1154b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov parcel.writeInt(mEnd); 1164b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1174b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 1184b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov @Override 11985b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov public int hashCode() { 12085b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov final int prime = 31; 12185b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov int result = 1; 12285b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov result = prime * result + mEnd; 12385b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov result = prime * result + mStart; 12485b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return result; 12585b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 12685b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov 12785b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov @Override 12885b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov public boolean equals(Object obj) { 12985b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (this == obj) { 13085b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return true; 13185b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 13285b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (obj == null) { 13385b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return false; 13485b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 13585b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (getClass() != obj.getClass()) { 13685b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return false; 13785b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 13885b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov PageRange other = (PageRange) obj; 13985b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (mEnd != other.mEnd) { 14085b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return false; 14185b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 14285b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (mStart != other.mStart) { 14385b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return false; 14485b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 14585b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov return true; 14685b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov } 14785b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov 14885b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov @Override 1494b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public String toString() { 15085b1f883056a1d74473fd9ce774948878f389ab6Svetoslav Ganov if (mStart == 0 && mEnd == Integer.MAX_VALUE) { 1514b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return "PageRange[<all pages>]"; 1524b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1534b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov StringBuilder builder = new StringBuilder(); 1544b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov builder.append("PageRange[") 1554b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov .append(mStart) 1564b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov .append(" - ") 1574b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov .append(mEnd) 1584b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov .append("]"); 1594b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return builder.toString(); 1604b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1614b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 1624b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public static final Parcelable.Creator<PageRange> CREATOR = 1634b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov new Creator<PageRange>() { 1644b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov @Override 1654b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public PageRange createFromParcel(Parcel parcel) { 1664b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return new PageRange(parcel); 1674b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1684b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov 1694b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov @Override 1704b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov public PageRange[] newArray(int size) { 1714b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov return new PageRange[size]; 1724b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov } 1734b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov }; 1744b9a4d16872bbb50712e007b419ac0b35ff1582dSvetoslav Ganov} 175