PATH |
NSMutableRange
- Inherits from:
- NSRange : Object
- Implements:
- Cloneable
- Package:
- com.webobjects.foundation
Class Description
An NSMutableRange is an object representing a range that can be changed. A range is a measurement of a segment of something linear, such as a byte stream. You can change an NSMutableRange's two primary values, its location and its length. The methods of NSMutableRange also enable you to alter an NSMutableRange based on its union or intersection with another NSRange object.
The main purpose for NSMutableRange is to provide a way for methods to return range values in an "out" parameter. A client creates and passes in one or more NSMutableRanges to a method and gets back changed objects when the method returns. NSMutableRanges are also useful for performance reasons; instead of creating multiple NSRanges in a loop, you can create just one NSMutableRange and reuse it.
Table 0-10 describes the NSMutableRange methods that provide the basis for all NSMutableRange's other methods; that is, all other methods are implemented in terms of these four. If you create a subclass of NSMutableRange, you need only ensure that these base methods work properly. Having done so, you can be sure that all your subclass's inherited methods operate properly.
Method | Description |
location | Returns the starting location of the receiver. Inherited from NSRange. |
length | Returns the length of the receiver from its starting location. Inherited from NSRange. |
setLength | Sets the length of the receiver. |
setLocation | Sets the starting location of the receiver. |
Interfaces Implemented
- Cloneable
- clone
Method Types
- Constructors
- NSMutableRange
- Accessing and setting range elements
- setLength
- setLocation
- Transforming ranges
- intersectRange
- unionRange
- Methods inherited from Object
- clone
Constructors
NSMutableRange
public NSMutableRange()
public NSMutableRange(NSRange aRange)
public NSMutableRange( int location, int length)
Instance Methods
clone
public Object clone()
intersectRange
public void intersectRange(NSRange aRange)
See Also: unionRange
setLength
public void setLength(int newLength)
See Also: setLocation
setLocation
public void setLocation(int newLocation)
See Also: setLength
unionRange
public void unionRange(NSRange aRange)
See Also: intersectRange
© 2001 Apple Computer, Inc. (Last Published April 17, 2001)