Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(779)

Side by Side Diff: sdk/lib/core/sink.dart

Issue 2822173002: Warn when adding something to a closed sink and improve documentation (Closed)
Patch Set: Improve documentation (issue 29122). Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file 1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
2 // for details. All rights reserved. Use of this source code is governed by a 2 // for details. All rights reserved. Use of this source code is governed by a
3 // BSD-style license that can be found in the LICENSE file. 3 // BSD-style license that can be found in the LICENSE file.
4 4
5 part of dart.core; 5 part of dart.core;
6 6
7 /** 7 /**
8 * A generic destination for data. 8 * A generic destination for data.
9 * 9 *
10 * Multiple data values can be put into a sink, and when no more data is 10 * Multiple data values can be put into a sink, and when no more data is
11 * available, the sink should be closed. 11 * available, the sink should be closed.
12 * 12 *
13 * This is a generic interface that other data receivers can implement. 13 * This is a generic interface that other data receivers can implement.
14 */ 14 */
15 abstract class Sink<T> { 15 abstract class Sink<T> {
16 /** 16 /**
17 * Put the data into the sink. 17 * Puts the [data] into the sink.
Lasse Reichstein Nielsen 2017/04/26 08:26:19 Change Puts-into into Adds-to. Or maybe "Pass-to"
floitsch 2017/05/01 16:46:25 I'm ok with repeating the name, if there is more d
18 * 18 *
19 * Must not be called after a call to [close]. 19 * Must not be called after a call to [close].
20 */ 20 */
21 void add(T data); 21 void add(T data);
22 22
23 /** 23 /**
24 * Tell the sink that no further data will be added. 24 * Closes the sink.
25 *
26 * The [add] method must not be called after this method.
25 * 27 *
26 * Calling this method more than once is allowed, but does nothing. 28 * Calling this method more than once is allowed, but does nothing.
27 *
28 * The [add] method must not be called after this method.
29 */ 29 */
30 void close(); 30 void close();
31 } 31 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698